mirror of
https://github.com/Mastermindzh/react-starter-kit.git
synced 2024-10-22 16:48:12 +02:00
47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
|
# react-starter-kit
|
||
|
|
||
|
Web project starter kit including modern tools and workflow based on
|
||
|
[create-react-app](https://create-react-app.dev/), best practices from the community, a scalable base template and a good learning base.
|
||
|
|
||
|
Includes:
|
||
|
|
||
|
- Redux-toolkit
|
||
|
- Vscode setup (debugging + snippets)
|
||
|
- Jest, @testing-library and Cypress
|
||
|
- Immer
|
||
|
|
||
|
<!-- toc -->
|
||
|
|
||
|
- [Getting started](#getting-started)
|
||
|
- [Project structure](#project-structure)
|
||
|
|
||
|
<!-- tocstop -->
|
||
|
|
||
|
## Getting started
|
||
|
|
||
|
1. `npm install`
|
||
|
2. `npm start` ([localhost:3000](http://localhost:3000))
|
||
|
3. `npm test` (run jest + coverage on [localhost:8080](http://localhost:8080))
|
||
|
|
||
|
## Project structure
|
||
|
|
||
|
Only the important files are shown
|
||
|
|
||
|
```bash
|
||
|
.
|
||
|
├── .vscode # vscode setup (debug, snippets, etc)
|
||
|
├── config # tool configuration
|
||
|
├── 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
|
||
|
```
|