CourseSignal is a course evaluation tool allowing students to rate and review individual assignments for a course, closing the feedback loop between instructor preparation and student experience.
The simplest way to build and run CourseSignal is with Docker.
To run CourseSignal in development mode, cd into the docker directory and run
docker-compose -f docker-compose.yml -f docker-compose.dev.yml upThis brings up docker containers corresponding to the various CourseSignal services.
On first run, the database is populated using the SQL scripts in the database/setup directory. In development mode, the CourseSignal tables are written to the test database. If these scripts are changed in any way, the container should be rebuilt by running the command docker-compose build from the docker directory.
The container is set up to mirror the contents of /var/lib/mysql onto the host filesystem in the database/data directory. To reset the database and run the setup scripts again, stop docker-compose, delete the database/data directory, and run docker-compose again.
To explore the database in the command line, while docker-compose is running, open another terminal and run
docker exec -it (docker ps --filter "label=container_name=coursesignal_db" -q) mysqlIf the CourseSignal service is having trouble finding dependencies (e.g. express, nodemon, etc.), try rebuilding the containers by running docker-compose build from the docker directory and restarting Docker compose. If you still run into dependency issues, try deleting the node_modules directory from within the frontend directory and installing dependencies from inside the frontend container:
docker exec -it (docker ps --filter "label=container_name=coursesignal_service" -q) npm install