A starter based on Create React App and Slash
Design System (Guidelines, Storybook)
git clone https://github.com/samuel-gomez/react-starter-toolkit.git
For VSCode users, you can open the workspace directly by double clicking on the app.code-workspace file
If you want to clean this demo, you have to launch (node required):
npm run clean
This script delete all files of the demo (see the CLEAN.md file)
After that, you can run :
npm i
git init
git add .
git commit -m "Initial Commit"
git remote add origin $repo__url
git push -u origin master
After installation, you have to personalize some parameters, you can check it in the CONFIG.md file
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:9999 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.
Launches the test runner with coverage and all warnings.
Launches the test runner with coverage and no warning (silent mode).
Launches the test runner for sonar report.
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!
If you want a helper to respect the conventional commits naming, Commitizen give a cli interface.
Script to launch eslint analyse.
With these plugins :
"extends": [
"react-app",
"plugin:prettier/recommended",
"plugin:@typescript-eslint/recommended"
],
"plugins": [
"prettier",
"@typescript-eslint"
],Script to launch eslint analyse with auto fix.
Script to launch prettier analyse.
Script to launch prettier analyse with auto fix.
Script to launch eslint analyse and prettier analyse with auto fix.
Script to launch husky installation, it's launched during the global installation.
If you detect a bug, please create an issue : https://github.com/samuel-gomez/react-starter-toolkit/issues
https://sonarcloud.io/project/overview?id=samuel-gomez_react-starter-toolkit
See the STRUCTURE.md file