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

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 to start development contaires.

   • This command works in any folder inside cloned repository
   • 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.

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 are related resources with command npm run test-setup:down

How to manually inspect database

Development setup includes database management tool called Adminer. 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