Equipment Manager web app for Ava Roasteria. A React/Next.js/JS/CSS/Supabase project.
- Clone the repo to your local machine.
- Create a
.env.local
file in project's parent folder:touch .env.local
- Message repo owner for Supabase Project URL and API key, and add them to the
.env.local
file. For example:NEXT_PUBLIC_SUPABASE_URL=<url_here> NEXT_PUBLIC_SUPABASE_ANON_KEY=<random_key_here>
- Run
npm i
in project's parent folder. - Finally, run
npm run dev
in project's parent folder, then navigate to thelocalhost
link given in terminal (eghttp://localhost:3000
)
The following are the tools and resources already installed and in-use in the project (see package.json). Ensure to use to keep consistency across contributions, as well as keeping project size small:
- Routing: Next.js App Router (https://nextjs.org/docs/app/building-your-application/routing#the-app-router)
- Icons: react-icons (https://react-icons.github.io/react-icons/)
- Tables: react-table-library (https://react-tables.com)
- Calendar: react-big-calendar
- Icons: react-icons
- Loading spinners and skeletons: react-loading-skeleton and react-spinners
Use the "Prettier" code formatter before submitting your code to keep consistency and code quality across contributions. Default settings should do, but ensure the following settings are set:
- Bracket spacing: enabled
- JSX single quotes: enabled
- Print width: 80
- Semi: enabled
- Tab width: 4
- Trailing comma: es5
- React: https://react.dev/reference/react
- Next.js: https://nextjs.org/docs
- Supabase: https://supabase.com/docs