Ohtuilmo

Registration, administration and review tool for University of Helsinki's software engineering project course.

Project links

• Definition of Done
• Work schedule
• Team practices
• Product backlog
• Worked hours
• Developer workflow instructions

Development

How to start development

1. Make sure you have docker, docker-compose and nvm installed.

2. Clone this repository to your computer.

3. Run nvm use && npm i in both in backend and frontend folders.

   • If you get error "Version x is not yet installed", you can install required node version by simply giving command nvm install and then try again.

4. Run docker compose up in any folder inside cloned repository to start development containers.

   • It will start 4 containers:

     Container	Port
     db	5432
     backend	3001
     frontend	3000
     adminer	8083

5. When you are done, close containers from the active console with shortcut CTRL+C or from other console with command docker compose down.

When there is change in dependencies

If frontend or backend dependencies change, ie. there is change in frontend or backend package.json file, you need to install dependencies again locally and rebuild containers:

1. Remove dev containers with command docker compose down

2. Run nvm use && npm i in frontend or backend folder or in both if both has had changes for dependencies.

3. Rebuild dev containers with docker compose up --build

How to restore database to its initial state

1. Remove containers and volumes related with command docker compose down --volumes

2. Restart dev setup with docker compose up

How to change user roles in dev environment

In development environment, login is faked in backend using fakeshibbo middleware. You can run software in different user roles by modifying faceshibbo in ./backend/middleware.js file.

Modify line const test_user = test_users.student to correspond user role desired (student, instructor, or admin). Changes take effect immediately when you save your changes and reload the page.

How to run Cypress tests

1. Switch to frontend folder.

2. Start test setup with command npm run test-setup. This will create 3 containers inside project ohtuilmo-local-test:

   Container	Port
   db	-
   backend	-
   frontend	3002

3. Run tests with graphic interface with command npm run test or in headless mode with command npm run test:headless.

4. If you want to restore test setup and the database to their initial stage, just run npm run test-setup again.

5. When you are done, you can remove containers and all related resources with command npm run test-setup:down

How to manually inspect database

Development setup includes database management tool called Adminer. With Adminer, you can easily inspect and modify database by using your browser. When development containers are running, navigate to http://localhost:8083/ and sign in with following info:

• System: PostgreSQL
• Server: db
• Username: postgres
• Password: postgres
• Database: postgres