THIS README needs to be finished
How to setup this project
- local Postgress db
- commands to make prisma work
- anything else ๐คท to make it work
We use react email to crete our email templates. To see what they look like you need to run a new project To set it up you need to run the script
npx create-email@latest
bump the number in package.json of react-email to 1.9.4 then run npm i and npm run dev
You will also need to place the emails you wish to see in the emails folder in the created project
Do code reviews, use branches, etc
If making db changes they need to be in their own separate PRs as non dev or main branches don't update the db
Need add more for (prisma pull push) , (for cypress)
npm run dev
This starts your app in development mode, rebuilding assets on file changes.
npm run clear-db
This runs a script that clears your connected database. This should never be run on production
This npm route script should be removed once we have customers using our system
npm run lint
This runs a script runs prettier over the codebase and will point out prettier errors that need fixing
npm run lint-fix
This runs a script runs prettier over the codebase and will automatically try and fix any style based issues
npm run storybook
Starts Storybook. We use storybook to show off what we have in our component library
npm run build
Builds the app for production
npm start
Runs the app as if it was in production