Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samuel-gomez/react-starter-toolkit
React Starter with Axa Design System
https://github.com/samuel-gomez/react-starter-toolkit
component create-react-app demo eslint javascript netlify prettier react react-oidc reactjs sass sonarqube storybook
Last synced: about 1 month ago
JSON representation
React Starter with Axa Design System
- Host: GitHub
- URL: https://github.com/samuel-gomez/react-starter-toolkit
- Owner: samuel-gomez
- License: mit
- Created: 2020-08-23T15:21:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-01T20:05:25.000Z (11 months ago)
- Last Synced: 2024-02-01T21:34:22.409Z (11 months ago)
- Topics: component, create-react-app, demo, eslint, javascript, netlify, prettier, react, react-oidc, reactjs, sass, sonarqube, storybook
- Language: TypeScript
- Homepage: https://react-starter-toolkit.netlify.app/
- Size: 14.3 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
React Starter Toolkit
A starter based on Create React App and Slash
Design System (Guidelines, Storybook)
Demo 😎
## 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](./docs/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](./docs/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](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](https://facebook.github.io/create-react-app/docs/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 :
```json
"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](./docs/STRUCTURE.md) file