Outlr PSE Project

Implementation

Outlr is a PSE (Praxis der Softwareentwicklung) project developed at the Karlsruhe Institute of Technology during the winter semester of 2022/23. This repo contains the code from the implementation and quality assurance phases. Some small changes were done after the submission deadline.

You are free to use everything in this repo.

How to deploy

Build and deploy from source

Note: The backend IP is hardcorded in the frontend. To change it, you can follow these steps:

1. Download the source code
2. Change the baseURL in frontend/src/api/AxiosClient.ts to the new IP of the backend
3. Go to the root folder of the project and rebuild it:

docker-compose build

4. Start the app:

docker-compose up -d

Deploy on localhost from Docker Hub

This deployment method is not available on GitHub

1. Start the docker daemon
2. Go to the latest release. Under Assests > Other download the Docker-Compose files
3. Extract the files and go to the extracted folder
4. Set a strong JWT_SECRET_KEY in the .env file
5. Run the following command to start the app:

docker-compose up -d

5. Go to http://localhost:1337/
6. To stop the app run:

docker-compose down