https://github.com/qaware/qaware-2024-code-night-schloss
https://github.com/qaware/qaware-2024-code-night-schloss
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/qaware/qaware-2024-code-night-schloss
- Owner: qaware
- Created: 2024-08-15T15:33:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T15:35:23.000Z (almost 2 years ago)
- Last Synced: 2024-12-25T16:42:09.690Z (over 1 year ago)
- Language: Python
- Size: 35.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 2024 Code Night @ Schloss Gymnasium Mainz
This repository is supposed to contain code for the Code Night at the "Gymnasium am Kurfürstlichen Schloss Mainz". For
this, a task for a two component microservice was designed, reproducing a simplified version of a warehouse system,
composed of a central server instance, which provides for a management of incoming and outgoing packages as well as a
client instance, which retrieves data from the server and displays it to a client of the warehouse company. For more
information concerning the task, check out the [specifications](TASK.md).
## Installation
0.) Optionally create a virtual environment for your python packages of this project:
```
python3 -m venv venv
source venv/bin/activate
```
1.) Install all dependencies:
```
python3 -m pip install -r requirements.txt
```
2.) Start the uvicorn backend:
```
uvicorn sendungsdatenverwaltung:app --reload
```
The reload command is used to be able to update the code and start the application automatically.
## Usage
After the installation the API can be called via curl or the browser to serve the user with data or as data storage.
## Maintainer
R. Kalleicher,
C. Thelen,