This joint repository is made to make running of our application simpler. It does not contain any source code. To see our source code navigate to the respective repositories:
The application is dependent on certain environment variables in order to run.
Add the following .env file to the root directory after cloning the project:
# Insert the following .env file to the root directory after cloning
DB_NAME=sparesti_db
MYSQL_URL=jdbc:mysql://db:3306/${DB_NAME}
MYSQL_USERNAME=root
MYSQL_ROOT_PASSWORD=password
SECRET_KEY=87EF7185F1C9A5053F5D0B25CCDF039FA3DEF82C0504ACDC9110FC444237BC57
[email protected]
EMAIL_PASSWORD=wakd klwc nivw whzl
- Clone the repository
git clone [email protected]:idatt2106-gruppe-2/idatt2106_2024_02.git
- Navigate to the project root folder
cd idatt2106_2024_02
- Create an
.envfile in the project root directory by copying over the.env.examplefile:
cp .env.example .env
If you are on Windows Command Prompt use:
copy .env.example .env
NOTE: We are fully aware that this file should not be public and that the user should use their own configuration parameters, but for the ease of the examiners we have chosen to do it this way.
- Run the application (OBS: Make sure docker is running). It will take a few minutes the first time you run the application.
make run
The application is now running on port 5173.
NOTE: If you don't have Make installed, use the following command instead:
docker compose up
To exit the application, use CTRL+C. You can rerun the application by using
make run again.
The database is populated with a pre-configured user at runtime which can be used to experiment with the application. You can log in with the following credentials:
- Username:
username - Password:
Test123!
To run tests navigate to the respective repositories.
The REST endpoints are documented using Swagger UI. The documentation is generated at runtime and can be found here.