United Way 211

What is 211?

211 is an information hotline run by United Way that refers callers to relevant health, human, and social services and agencies. Specifically, we're working with United Way Greater Knoxville, who have served 13,000 calls in 2022.

Repository Overview

This project has two main parts:

1. A user-friendly information intake form (used by 211 to collect info from partnered agencies) with conveniences like form validation and autofill.
2. An admin dashboard, where 211 staff can easily review and manage information of partnered agencies.

Getting Started

Prerequisites

• Node.js (v18)
• pnpm
• Visual Studio Code

1. Clone the repository

git clone https://github.com/hack4impact-utk/uw-211

2. Open UW-211 in VS Code and accept recommended extensions

3. Install dependencies

pnpm install

4. Set the environment variables

Either ask a project lead for the .env.local file or create your own. The .env.local file should be in the root directory of the project. You need to have the following variables set:

Variable Name	Description
MONGODB_URI	URI for MongoDB database
AZURE_AD_CLIENT_ID	Used for Azure services
AZURE_AD_TENANT_ID	Used for Azure services
AZURE_AD_CLIENT_SECRET	Used for Azure services
NEXTAUTH_SECRET	Used for NextAuth.js
NEXTAUTH_URL	Used for NextAuth.js
BASE_URL	URL for the current server

5. Run the development server

pnpm dev

Building for Production

Make sure you have finished all the setup steps in the Getting Started section and you can run the development server before building for production.

1. Build the project

pnpm build

2. Run the project in production mode

pnpm start

Testing

Running tests

pnpm test

Code/PR Workflow

• Create a new branch in the format [GITHUB USERNAME]/[SHORT FEATURE DESCRIPTION]-[ISSUE NUMBER]
  • For example: hack4impact-utk/add-login-page-1
• Make changes on your branch, ensuring you adhere to our style guide and best practices (add links here when ready)
• Commit your changes and push them to GitHub
• Create a pull request from your branch to main
  • Ensure you diligently follow the pull request template

Project Structure

• src/app: Contains pages for the application using the NextJS App Router
  • [locale]/[id]: Information intake form
  • [locale]/complete: Information intake form completion page
  • [locale]/dashboard: Admin dashboard
  • [locale]/signin: Admin dashboard sign in page
• src/components: Contains React components used across the project
  • There should be a folder for each component with an index.ts file that exports the component
• src/server/actions: Contains functions that interact with the database through the Mongoose ODM
  • Agencies.ts: Functions to find, create, update, and delete agencies.
  • PdfGeneration.ts: Generates a PDF by populating fields of the old information form.
• src/server/models: Contains Mongoose models for the database
• src/services: Contains functionality for interacting with external data sources (e.g. APIs)
• src/types: Contains TypeScript types and interfaces used across the project
• src/utils: Contains utility functions used across the project
  • constants: Contains constants like Zod schemas, common error messages, form steps, and enums.
  • types: Contains TypeScript interfaces for things like Mongoose models and dashboard parameters.
• test: Contains utilities to test server actions.

About Hack4Impact

Hack4Impact is a student-led organization that builds software solutions for local non-profits (read more here).

License

This repository is licensed under "The Unlicense" (read more here).