ITSC 4155 Project

This is a final project for ITSC 4155. It integrates with Canvas and Todoist to automatically add action items from courses in Canvas to Todoist as tasks.

Local Development

To run the frontend locally, you must have Node 20 installed and install the packages described by frontend/package.json. From there, you can run ng serve in frontend to start the frontend on http://127.0.0.1:4200.

To run the backend locally, you must have Python 3.10 installed and install the modules described by backend/requirements.txt. If you wish to run unit tests, you must also install the modules described by backend/requirements-dev.txt. From there, you can run python3 -m flask run in backend/src to start the backend on http://127.0.0.1:5000/.

You will also need to create certain secret files to test locally. To run everything without Docker, the following files are needed. Examples or descriptions of these files can be found in the secrets.example folder.

• connection_string.txt - the database connection string. An in-memory sqlite database (sqlite://) is sufficient.
• session_secret.txt - a random value used to sign sessions. Any value will work here.
• todoist_secret.txt- the client secret for the Todoist OAuth integration. This can be requested by creating an app here.
  • In the Todoist app, "OAuth redirect URL" must be set to "http://localhost:5000/api/auth/todoist/get_token_info" and "App service URL" must be set to "http://localhost:5000/".
  • The environment variable 'TODOIST_CLIENT' must be set to the app's "Client ID".
• todoist_secret_encrypt.txt - the secret used to encrypt Todoist API keys on the server.

Deployment

This project can be deployed with Docker Compose. By default, the frontend is exposed on port 4200 and the backend is exposed on port 5000. The files in the "util" directory can be used to automatically update the project on new commits to main. The steps to do this are:

1. Install update-repo.service and update-repo.timer to /etc/systemd/system.
2. Enable and start update-repo.timer.
3. In the secrets directory, supply a certificate named site.crt and a key named site.key.
4. In the secrets directory, supply the secrets described below.

• connection_string_docker.txt - the connection string that the backend Docker container will use
• db_password.txt - the user password for the database user
• db_root_password.txt - the root password for the database root user
• site.crt - a certificate for the site. May be self-signed
• site.key - the private key for the site.
• todoist_production_secret.txt - the OAuth client secret for the Todoist application.
• todoist_prod_secret_encrypt.txt - the secret used to encrypt Todoist API keys.

From there, the repo will be updated every minute. If there is a change, the Docker images will be rebuilt and redeployed. If a new secret is added, it must be manually added to the host machine before the commit that requires the new secret is merged with main.