NAR is a nonprofit that provides housing and life skills programs for women recovering from addiction, domestic violence, homelessness, and post-incarceration challenges.
They currently track client progress, rent payments, and donor outreach manually using notepads and spreadsheets, which is both time-consuming and error prone.
The goal is to develop an admin-sided client management system to manage client tasks, track rent payment, and simplify client intake.
Please have the following installed on your machine:
- Node.js
- PNPM
- VSCode
Please have the following VSCode extensions installed:
- Prettier
- ESLint
- Code Spell Checker
- markdownlint
Create a .env file in the root directory of the project and add the following variables. Please contact leadership to obtain the following secrets:
DATABASE_URL=
NEXTAUTH_URL=
NEXTAUTH_SECRET=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
- Run
pnpm installto install the dependencies. - Run
pnpm run devto start the development server.
Branch protections are enabled on this repository. To contribute, please create a new branch and make a pull request. The rules for branch names are lax, just be sure to include your name.
An example branch name for a card that adds a reset password email would be:
rudra-reset-password-email
Your pull request title must follow the conventional commits specification. An example of a valid pull request title is:
feat: Add pending form submissions table
The .vscode/launch.json file is configured to run Next.js in debug mode. This can let you step through your code line by line and inspect variables.
To start debug mode, navigate to the Run and Debug tab in VSCode, select the mode, and click the green play button.