Starting template

This README will need to contain a description of your project, how to run it, how to set up the development environment, and who worked on it. This information can be added throughout the course, except for the names of the group members. Add your own name (do not add the names for others!) to the section below.

Description of project

Group members

Profile Picture Name Email
Vian Robotin V.Robotin@student.tudelft.nl
Reinier Schep R.J.H.Schep@student.tudelft.nl
Mana Mahmoudi M.Mahmoudi-1@student.tudelft.nl
Laimonas Lipinskas L.Lipinskas@student.tudelft.nl
Kuba Trzykowski J.A.Trzykowski@student.tudelft.nl
Simona Lupșa S.C.Lupsa@student.tudelft.nl

How to run it

Important!

This tutorial assumes that:

  • You have cloned the latest main branch of this repo to a local folder on your machine.
  • You have python3 installed on your machine.

Setting up the server (this has to be done only once).

  1. Open the project in Intellij.
  2. You should get a notification that says that a Gradle build script has been found, load it.
  3. Navigate to repository-template/server/src/main/java/server/Main.java and click setup JDK.
  4. Click Add Configuration (located top right to the right of the green hammer icon)
  5. Click Add New Configuration (the '+' sign top left)
  6. Select Spring Boot from the list.
  7. Set the name to Main and Main class to server.Main.
  8. Click OK.
  9. Run the server by selecting the Main configuration and clicking the green play button, this is necessary for the following step!
  10. Navigate to repository-template/helper-scripts and open your terminal in that directory.
  11. Copy the absolute path of the activities.json file, it can be found in repository-template/server/src/main/resources/activities.json
  12. Execute the following command in your terminal: python3 add_activities.py "C:\Users\YourPath\activities.json"
  13. You should see a bunch of <Response [200]> printing to your terminal, once this finishes the database has been successfully populated with activities

Running the server

  1. Select the Main configuration.
  2. Click the green play button to the right of it.
  3. The server will start.

Running the client

  1. Click on the Gradle logo located on the right.
  2. Navigate to quizzzz/client/Tasks/application
  3. Once here, double click run, this will load the client.

FAQ

Question

When i run the client on my laptop, it's bigger than my screen, how can i make it fit properly?

Answer

Assuming you're on Windows 10, go to Settings > System > Display > Scale and Layout and set your scaling setting to 100%.

How to contribute to it

  1. Pick an issue you'd like to work on.
  2. Make branch off the dev branch with an appropriate name.
  3. Complete the feature on this branch.
  4. Make a merge request to merge your branch back into dev.

Copyright / License (opt.)