![Project Logo/Thumbnail - Optional]
- 📖 About the Project
- 💻 Getting Started
- 👥 Author
- 🔭 Project Structure
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- 📝 License
Provide a brief but informative introduction to your full-stack application starter template. Explain its purpose, the problems it solves, and any key benefits it offers to developers. Mention the technologies it's built with, such as React, TypeScript, Redux, and SCSS.
List the key features and functionalities that your starter template provides. This section should give potential users an idea of what they can accomplish using your template. For example:
- User authentication system with JWT
- Pre-configured Redux store with sample actions and reducers
- Basic routing setup using React Router
- SCSS for efficient styling
- Example API endpoints and database connections
Specify any prerequisites that users need to have installed or set up before they can use your starter template. This could include software, tools, or services. For example:
- Node.js and npm (Node Package Manager)
- A code editor (e.g., Visual Studio Code)
- Git (optional but recommended)
Clone this repository to your desired folder:
cd my-folder
git clone git@github.com:NickEmma/react-typescript-scss-starter.git
Install this project with:
cd react-typescript-scss-starter
yarn add || npm install
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Please be advised that our project is released under the terms of a License. Please ensure that you read and understand the terms of the MIT License before using our project.
- Techie Emma for the UI design inspiration for this project.