Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 2.06 KB

README.md

File metadata and controls

66 lines (48 loc) · 2.06 KB

Able Alliance

Overview

Able Alliance is a GT student organization that is dedicated to improving on-campus disability inclusion via access & resource sharing, community & social support, etc. This is a transporation management system built for them. Learn more about the organization at https://sites.gatech.edu/gtablealliance/.

Deployment Preview

A deployment preview of the main branch from netlify is available here.

Netlify Status

Environment Setup

Copy .env.example to .env and fill in your API keys:

cp .env.example .env

For host development, use localhost instead of Docker service names.

Development Setup

  • Install Node.js 24
  • Install MongoDB Community Server for a local MongoDB instance, or use MongoDB Compass to inspect the database.
  • Install and enable Prettier in VS Code (optional but recommended).
  • Ensure a MongoDB instance is running locally. For example:
    docker run --name mongodb -d -p 27017:27017 mongo
  • In the project root, run:
    npm ci
  • Start the Next.js dev server:
    npm run dev
  • Open http://localhost:3000/ in your browser.

Run With Docker

  • Install Docker.
  • Development:
    docker compose up --build --watch
  • Production:
    docker compose -f docker-compose-prod.yml up --build

Seeding the Database

To seed the database with sample users, locations, vehicles, and routes, run:

npm run seed -- "mongodb://localhost:27017/able-alliance"

Major Technologies