Course Planner

Quick Start

This setup uses docker and docker-compose for local development, as defined in docker-compose.yml. Installation instructions for various platforms can be found here.

1. Copy .env-example to .env (cp .env-example .env) and fill in the appropriate values.

2. Clone mark-one to a folder beside this project - e.g:

   .
   ├── course-planner
   ├── course-planner-etl
   ├── mark-one
   

3. If in development, check out the develop branch:

   git checkout develop

4. Install the required packages:

   npm install

5. Start the project, run:

   docker-compose up

6. Run the database migrations:

   docker-compose exec node npm run orm -- migration:run

7. Run the database migrations generate if you have database schema changes:

   docker-compose exec node npm run orm -- migration:generate -n [name-of-the-migration]
   docker-compose exec node npm run orm -- migration:run

8. switch to course-planner-etl and migrate the data:

   cd ../course-planner-etl
   git pull
   npm install
   npm run start

Note: You need to remove the old data from docker volume in order to migrate new the data and schema, otherwise the old data and schema might cause issues.

docker volume ls
docker volume rm course-planner_postgres_data