react-starter-kit/README.md

react-starter-kit

Web project starter kit including modern tools and workflows based on create-react-app and best practices from the community. Provides a scalable base template and a good learning base. Suitable for enterprise usage

Includes:

• Redux-toolkit
• Vscode setup (debugging + snippets)
• Jest, @testing-library and Cypress
• Immer

Table of contents

• Getting started
• Project structure

Getting started

1. npm install
2. npm start (localhost:3000)
3. npm test (run jest + coverage on localhost:8080)

Project structure

Only the important files are shown

.
├── .vscode # vscode setup (debug, snippets, etc)
├── config # tool configuration
├── cypress # e2e tests
├── dist # production version
├── public # directory with public files (config, icons, etc)
├── scripts # Modified default create-react-app scripts
├── src # application source
│   ├── app # redux-toolkit hooks + store
│   └── infrastructure # infrastructure code (wrappers, navigation, config file class)
├── CHANGELOG.md # update this whenever you update the application
├── Dockerfile # Dockerfile to build nginx container
├── jest.config.js # configuration for jest
├── package.json
├── README.md # keep this up to date
└── tsconfig.json