@inovando/cra-template

⚡️ Inovando's template for create-react-app

Preview

| Desktop | Mobile | |---------|-----------| | | |

Usage

1. Initialize your project with this command:

npx create-react-app my-app --template @inovando

2. Duplicate .env.example to .env.development.local and .env.production fulfilling variables as needed

3. Run the following commands:

yarn start # React server
yarn mock # Mock server (to see table example)

4. Done 🎉

5. (Optional) If you need PWA, don't forget to change icons at public/site.webmanifest

6. (Optional) If your project will use Cypress and your OS is Linux Ubuntu/Debian, you need to run the following commands:

sudo apt-get install libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2 libxtst6 xauth xvfb

7. (Optional) Duplicate cypress.env.example.json to cypress.env.json fulfilling variables as needed

Scripts

yarn serve

Serve app based on build/ folder (generated by yarn build)

yarn build-and-serve

Build and serve build/ folder

yarn generate:crud

Will prompt some questions to create a new CRUD with 3 routes (/entity, /entity/new, /entity/:id)

yarn generate:crud-modal

Will prompt some questions to create a new CRUD based on a modal with 1 route (/entity)

Features

• [x] ESLint/Prettier
• [x] Axios
• [x] Styled Components
• [x] React Final Form
• [x] Yup
• [x] Husky/Lint Staged
• [x] Material UI
• [x] React Router
• [x] React Toastify
• [x] CRUD Example
• [x] Commitizen Friendly
• [x] Generate Code from CLI
• [x] Code Splitting
• [x] Sentry
• [x] PWA Ready (All required variations can be generated with Real Favicon Generator)
• [x] date-fns
• [x] Numeral.js
• [x] JS Brasil
• [x] Cypress
• [ ] SWR

FAQ

Why ESLint and plugins are dependencies?

Until the release date of this package, create react app does not support devDependencies field at template.json

Git hooks not working

rm -rf node_modules && yarn