An opinionated quick start Create React App (CRA) template with configured Redux, TypeScript, React Router, React Testing Library and custom ESlint configuration.
Original Create React App README available here
npx create-react-app your-project-name --template typescript-redux
Or
yarn create react-app your-project-name --template typescript-redux
npx
command installs the most recent stable version of CRA from npm.
--template
parameter points to this template, note that cra-template-
prefix is omitted.
You know the pain. You start a new project from scratch and need to configure it again and again. It needs routing, ok you setup Router, then you need Redux - ok, oh 😩Redux boilerplate is taking so much time to type. Wait... what if you could have all the tools you want just from the beginning? I want to focus on building amazing projects and not spending hours configuring. That's why I've created this template. It's here for you to use.
In the project directory, you can run:
-
yarn start
- runs the app in the development mode. Open http://localhost:3000 to view it in the browser. -
yarn test
- launches the test runner in the interactive watch mode. -
yarn build
- builds the app for production to thebuild
folder. -
yarn eject
- exposes content ofreact-script
package -
yarn lint
- lints project files according to eslint rules, see below. Typical use case: continuous integration environments, Travis, CircleCI, etc. -
yarn fix
- same asyarn lint
, but also fixes errors, when possible. Typical use case: local development environment, git hooks.
Due to CRA template limitations (we can change only scripts
and dependencies
inside generated package.json
) all configuration is done by adding config files where possible. Also no devDependencies
for now, sorry.
The template provides basic Redux configuration with feature based folder structure. You can use Redux devtools browser extension. Sample feature included in src/features
folder, note technology agnostic features
folder name. Based on Redux maintainers recommendation.
Testing is done with React Testing Library.
I added prettier
to force consistent formatting. Don't like trailing semicolons? Feel free to tweak prettier rules inside .prettierrc
file to match your code style.
The template extends CRA ESLint rules with a custom set, tailored for the reasonable and clean development process.
Eslint rules are commented for your convenience feel free to tweak or remove them inside .eslintrc
. No judgment.
I created a step by step guide on how to create your own templates. Check it
I hope this template will be helpful for you and you will love using it 💖!