☝ Change this badge by editing README.md
after cloning this repo
- Node v11.1.0
- yarn
$ git clone git@github.com:SeasonedSoftware/new-react-app.git $$your-project-name$$
$ cd new-react-app
$ yarn
Run the following command and follow the instructions on terminal:
$ yarn scaffold
It will initiate your website's title and will create the .env
and .env.local
files
$ yarn start
$ git clone git@github.com:SeasonedSoftware/new-react-app.git $$your-project-name$$
$ cd new-react-app
$ docker-compose run front yarn
Run the following command and follow the instructions on terminal:
$ docker-compose run front yarn scaffold
It will initiate your website's title and will create the .env
and .env.local
files
$ docker-compose up
Your browser should automatically open at: localhost:3000
.
- This project heavly relies on Croods and Croods-auth projects. Make sure you read their docs.
- If you want to add context providers for your whole app, edit the
./src/core/Providers.js
file. - There are some built in helpers (
./src/utils/helpers.js
) and hooks (./src/utils/hooks.js
). Make sure you get to know them before you start rewriting them. - If you want to enable/disable custom lint rules, edit the
.eslintrc.js
file.
$ yarn test
$ yarn test --coverage
The coverage will be available on the coverage/
folder. Open coverage/lcov-report/index.html
on your browser to see details.
$ yarn lint
Create a new Website on Netlify from this project's repo (master branch) with default configuration.
Merging to master
branch will automatically deploy to Netlify.