National Nonprofit Portal
Stack
- React.js: Front-end
- Chakra UI: React components
- Next.js: Page/API routing and pre-rendering
- MongoDB: Permanently storing data
- Next Auth: User authentication
- eslint: Automatically identifying and fixing code errors
- prettier: Enforcing common coding style
Development
- Clone this project to your computer
- Navigate to this project in your terminal
- Run
npm ci
to retrieve dependencies - Run
npm run secrets
to sync secrets to.env.local
- You will be asked for a password, ask your EM to send it to you
- Note: Windows users will need to run
npm run secrets:login
andnpm run secrets:sync
instead
- Run
npm run dev
to start the application
Useful Commands
When you commit your code, both of the commands below are run automatically.
npm run lint
: Check for errors in your codenpm run format
: Fix code styling
Additional Information
- Use
[NAME]/[ISSUE_NUMBER]-[SHORT_DESCRIPTION]
when naming your feature branches - Highly recommended to use VSCode with ESLint and Prettier extensions
- To save even more time, set up "Format on Save"