Minor Choice portal

This repository contains the Minor Choice webapp created in the hackaton of Software for Science.

Pre-requisites

• Docker

• Docker compose

• Node.js

• Bash CLI

• One of the following operating systems

  • Linux
  • Unix
  • Windows 10 Pro

Running the application locally

To run the application locally, open 2 command prompts. Start in the root directory of the project when executing these commands.

Starting the backend

Before running these commands, create a file called .envin the app directory.

cd app
touch .env

Populate the .env and the .env.test file with the following template:

DB_HOST=
DB_PORT=
DB_USER=
DB_PASS=
DB_NAME=

Then enter the corresponding values without enclosing quotation marks. They are respectively the hostname, port, username and password for a MariaDB server. The database name should be sfs or sfs_test. Afterwards, the backend can be run. Please note that npm install is only required on a change in the package.json or on the first start in both the app and client.

npm install
npm start

Starting the frontend

The frontend does not require any configuration. Run the commands below to run the frontend locally.

cd client
npm install
npm start

---

You are now able to access the frontend on port 3000 and the API on port 4000

---

Deploying the Docker container

Before proceeding to deploying the Docker containers, make sure the folder name in which your local repository resides is called sfs-hackaton.

To build the Docker images and start them, run the following commands from the root directory of the project.

cd scripts
./build-docker.sh

Stopping the Docker container

To redeploy the containers, stopping the Docker containers is required. You can stop the Docker containers any time you wish if you're not redeploying.

Change your directory to scripts from the root directory and run the stop script.

cd scripts
./stop-docker.sh

---

API Calls

GET Endpoints

Retrieving the questions

This endpoints retrieves the specified questions for the questionnaire, the language is specified in the lang parameter as shown in the table and example below.

"/questions?lang={lang}"

---

Parameter	Options
lang	NL or EN

---

Example

"/questions?lang=EN"

---

Getting a saved result

This endpoints retrieves a result of a peer of yourself, using the UUID to get the personal top 5.

"/result?id={id}&lang={lang}"

---

Parameter	Options
lang	NL or EN
id	Generated UUID gotten from the POST call on the result endpoint documentend below

---

Example

"/result?id=ad1ec3b2-2251-401b-a4e5-d2b86284da7d&lang=EN

---

POST Endpoints

---

Post the collected tags to parse the results

This endpoints receives the count of all tags collected from the questionnaire and the programme the student is following.

"/result"

Request header: "application/json"

---

Parameter	Types	example
counts	Object	{ [tag]: 4, [tag2]: 4}
programme	String	"MyProgramme"