Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 3.13 KB

README.md

File metadata and controls

93 lines (60 loc) · 3.13 KB
Raw

U.C.T. Locator

This is a web application that allows caregivers to locate accessible universal changing stations.

Getting Started

There are some things you'll want to read through before you get into the project.

Make sure to read everything thoroughly, and try to complete all the steps. Some of it may be somewhat confusing, but stick with it. It may take some time, but we believe in you!

Advanced

Beyond the basics, there is some advanced tooling that may help with the development of the project.

Create an .env file in the back-end directory and add the following

SECRET_KEY="<secret key>"

The Secret Key can be any string, its the key for the JWT.

Once the .env file has been created, cd into the back-end directory, and run these:

npm install
npm run server

Database

The backing database for this project is Postgres. Easiest way to get one of those running locally is simply to use Docker. You can use the following command to get a Postgis enabled Postgres instance up and running.

docker-compose up -d

We also spin up an instance of pgAdmin4 to make querying the database easy. It runs on http://localhost:5050.

Login credentials can be found in the docker-compose.yaml file.

Migrations

In order to keep databases up-to-date with schema changes, this repo uses sequelize-auto-migrations-v2 to manage and run schema migrations.

Use the following commands for common tasks for schema migrations:

  1. Check migrations status for the current db: npx sequelize-cli db:migrate:status or npm run db-status

  2. Run any pending migrations: npx sequelize-cli db:migrate or npm run db-up

  3. Revert db changes from the last migration: npx sequelize-cli db:migrate:undo or or npm run db-down

  4. Add a new migration script by updating your models and then running:

    cd back-end
NODE_ENV=local npx makemigration --name '<name that describes you changes>'

Front-End

For the front-end, you should be able to simply cd into the front-end directory, and run this:

npm install
npm run start

Advanced

Nx

You can also use Nx to build, run, and manage projects in this repository.

First, install Nx with npm install nx --location=global.

Next, it's possible to run any script for any project anywhere in the repo, with no need to change directories to that project.

Use nx <script-name> <project-name> where script-name is the npm script defined in the project's package.json to run, and project-name is the name specified in the project's package.json name field.

Examples

Here are some examples showing how to run the front-end and back-end.

  1. Start UCT Locator Front-End

    nx start uct-locator-front-end

  2. Start UCT Locator Back-End

    nx server uct-locator-back-end