- Click on "Use this template"
- Create a new repository
- Clone the repository you created to your local machine
- Run
npm install
- React and Redux
- Material UI (with a customizable theme)
- TypeScript
- React Router
- Additional React tools such as react-hot-loader
- Additional Redux tools bundled with Redux Toolkit such as redux-thunk, redux-persist, and redux-devtools-extension
- Linters and Formatters pre-configured such as Prettier, ESLint, MarkdownLint, and EditorConfig.
- GitHub Actions CI/CD pipeline.
- Git hooks with Husky and Lint-Staged.
- Add your Firebase Config to
src/Utils/config.ts - Run
npm start - Open localhost:3000 and see your website
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
If you want to contribute, please fork the project, make changes, and submit a pull request. Check out first contributions if you are new to contributing.