React Starter Toolkit

A starter based on Create React App and Slash Design System (Guidelines, Storybook)

Demo 😎

You can see a demo here

Installation 🚀

Cloning

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

🚨 Before installation 🚨

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

Remote

git init
git add .
git commit -m "Initial Commit"
git remote add origin $repo__url
git push -u origin master

Configuration ⚙️

After installation, you have to personalize some parameters, you can check it in the CONFIG.md file

Available Scripts

In the project directory, you can run:

`npm start` 🏁

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.

`npm test` or `npm t` 🔬

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

`npm run cover:local`

Launches the test runner with coverage and all warnings.

`npm run cover` ☂

Launches the test runner with coverage and no warning (silent mode).

`npm run test:sonar` 🗼

Launches the test runner for sonar report.

`npm run build` 📦

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!

`npm run cz` ⛩

If you want a helper to respect the conventional commits naming, Commitizen give a cli interface.

`npm run lint` 👮‍♂️

Script to launch eslint analyse.

With these plugins :

"extends": [
"react-app",
"plugin:prettier/recommended",
"plugin:@typescript-eslint/recommended"
],
"plugins": [
"prettier",
"@typescript-eslint"
],

`npm run lint:fix` 👮‍♂️⛑

Script to launch eslint analyse with auto fix.

`npm run prettier` 🎩

Script to launch prettier analyse.

`npm run prettier:fix` 🎩⛑

Script to launch prettier analyse with auto fix.

`npm run check` 👍

Script to launch eslint analyse and prettier analyse with auto fix.

`npm run prepare` 🐶

Script to launch husky installation, it's launched during the global installation.

Issues 🐞

If you detect a bug, please create an issue : https://github.com/samuel-gomez/react-starter-toolkit/issues

Quality 💎

SonarCloud

https://sonarcloud.io/project/overview?id=samuel-gomez_react-starter-toolkit

Structure

See the STRUCTURE.md file

License

samuel-gomez/react-starter-toolkit

ErrorLooks like something went wrong!

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 17

Packages 0

Uh oh!

Contributors 6

Languages

Error
Looks like something went wrong!

Packages