Skip to content

Latest commit

 

History

History
193 lines (128 loc) · 6.93 KB

README.md

File metadata and controls

193 lines (128 loc) · 6.93 KB
Raw

🧭 Project Compass

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

Useful resources:

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

    NOTE: If you get into a login loop, double check that the Docker services are running

  4. Seed database (Optional)

    This runs the seed script with test data. You will first need to log in to Compass with Google OAuth to create the first user (see Authentication section below). Then, run the following:

    npm run db:seed           # Seed the database with test data

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>

  1. Install dependencies, starting in the compass directory

    npm install           # install dependencies

  2. 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

Authentication

Your .env.local file will need to be updated with valid values for GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET. This will allow you to log in with Google OAuth into Compass.

To update GOOGLE_CLIENT_ID:

  • Navigate to Google Cloud
  • Create a "Client ID for Web application"
  • Populate the fields as below (note the name and authorized redirect URIs fields) alt text
  • Copy the client ID field on the upper right of the modal (not shown in screenshot), after creation

To update GOOGLE_CLIENT_SECRET:

  • Copy the google client secret after creation of the client id

Email

Option 1: Use Mailcatcher in Docker

If you're following Option 1 above to run supporting services in Docker, the .env.example file is already configured to send email to the Mailcatcher server running on port 1025 for SMTP. The Mailcatcher server will "catch" all email sent and save it in memory to be viewed in its web-based interface running on port 1080. Open it in your web browser at: http://localhost:1080

Option 2: Configure a live mail server

If you're not running supporting services in Docker, or wish to test email sending to some test accounts (please take care not to send test emails to real people!), you can configure the following variables in your .env file:

  1. For an SMTP server 
    EMAIL_SERVICE=smtp
EMAIL_AUTH_USER=[username for your SMTP server]
EMAIL_AUTH_PASS=[password for your SMTP server]
[email protected]
EMAIL_HOST=[host name for your SMTP server]
EMAIL_PORT=[port for your SMTP server- typically 587 or 465 for secure connections]
  2. For a Gmail account 
    EMAIL_SERVICE=gmail
EMAIL_AUTH_USER=[your Gmail address]
EMAIL_AUTH_PASS=[your Gmail password]
EMAIL_FROM=[your Gmail address]
EMAIL_HOST=
EMAIL_PORT=

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).

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.

Troubleshooting

Compass app is not running:

Make sure that Docker is running in the background

Login screen flashes like it is stuck in a loop

Make sure that Docker is running in the background

Seeding script does not work

Log in with your Google credentials first, and rerun to generate the first user.

Postgres refuses to start

Ensure you have port forwarding for port 5432 from Docker to your local machine set up, and that you are not already running Postgres in the background for another servie.

Client id is required:

Fill out the Google Client ID and Google Client Secret in .env.local

Tech stack & libraries