This is the front-end app for ShepherdTutors, written in React and bootstrapped with create-react-app.
- Run
npm installto install the project's dependencies. - Run
npm run prepareto set up husky, which we use for pre-commits. - Run
npm run startto launch the project onlocalhost:3000. PRO-TIP: Favornpmoveryarn. Funny things can happen when your package-lock.json clashes with this project's yarn.lock.
npm run lint— to run eslint on your codenpm run lint-and-fixto detect and fix linting errors.npm run buildto create an optimized production build of the React code.npm run prettier-formatfor prettier formatting. Applies global prettier fixes to the codebase.npm run analyzeto analyze your build.
- The
mainbranch serves the production code. - The
devbranch serves the dev code. - We have no strict requirements about how you should name your own branches, though something like
{type}/{scope}is nice (an example would befeature/pdf-viewerthat tells us you're creating the pdf-viewer feature on that branch.)
- Ensure your pre-commits return
everything is awesome. - Ensure your code passes the Netlify deploy pipeline (all green checkmarks, no red x'es).
- Have at least one other project contributor review your code before merging with either the
devormainbranch. - Do not use the force. Do not force-push. If you have a nasty git resolution problem, shoot an SOS message in the Slack channel, and one of your colleagues will be around to assist!
Happy coding, and LGTM!
