🧭 Project Compass

Compass is a tool to help educators create and manage Individualized Education Programs (IEPs) for better student outcome.

Useful resources:

• Notion wiki
• Slack channel

Contributing to our code base

One time setup

1. Install Docker Desktop

2. Clone the GitHub repo:

   • Windows users (do this first before checkout) : make sure to run git autocrlf setting is set to false so that carriage return characters are not inserted into files (which breaks them when they run inside the Linux container). To do so, open a Powershell and run: git config --global core.autocrlf false
     

   cd <parent folder of compass>
   git clone https://github.com/sfbrigade/compass.git
   cd compass

3. Create the local server env file:

   cp .env.example .env.local

Running Compass

There are two ways to run Compass locally:

Option 1: Run server locally, and supporting services in Docker

1. Install node dependencies, starting in the compass directory

   npm install           # install dependencies

2. Start services in Docker & reset the database

   docker compose -f supporting_services/docker-compose.yml up -d  # start the services in the background
   npm run db:reset      # reset and migrate the database

3. Start the server

   npm run dev           # start the server in development mode

   Server URL: http://localhost:3000

Option 2: Run both server and supporting services locally

1. One time setup:

• Install and configure Postgres:
  • install using pgAdmin 4, Homebrew, or any other method
  • create a username and password on the Postgres server
  • update the DATABASE_URL in .env.local to include your actual <username> and <password>:

    DATABASE_URL=postgres://<username>:<password>@localhost:5432/compass
    

• Install MinIO, an open source S3-compatible storage server:
  • follow their guide for macOS or Windows
  • after installing and starting the MinIO server, make sure to create a new bucket and update the S3_USER_UPLOADS_BUCKET_NAME in .env.local to match the name of the bucket you created:

    S3_USER_UPLOADS_BUCKET_NAME=<bucket-name>
    

2. Install dependencies, starting in the compass directory

   npm install           # install dependencies

3. Reset the database and bring up the server

   npm run db:reset      # reset and migrate the database
   npm run dev           # start the server in development mode

   Server URL: http://localhost:3000

Running tests

The database container does not need to be started to run tests, but Docker Desktop must be running in the background.

Run all tests with npm run test. An individual test file can be run with npm run test <path/to/file> (e.x. npm run test src/routes/students.test.ts).

To run tests in watch mode, use npm run test:watch. This will run tests whenever a file is changed, but will not take database schema changes into account.

Database

Creating migrations

Until Compass is deployed, the initial migration file at src/api/db/migrations/1_initial-migrations.sql should be edited. Once Compass is deployed, new migrations can be created in the same directory by adding 1 to the number of the last migration file.

Running migrations

Run npm run db:migrate to migrate the database. However, until Compass is deployed, you'll more likely want to run npm run db:reset to reset the database since we'll be making changes to the initial migration file.

Tech stack & libraries

• Winston
• PostgreSQL
• Kysely (type-safe SQL query builder)
• Zapatos (type-safe Postgres helpers, mostly used to generate typings for Kysely)
• AVA (test runner)