Skip to content
Snippets Groups Projects
Commit d97d5a15 authored by Nadja Geisler's avatar Nadja Geisler :sunny:
Browse files

add structure documentation

document project and (future) app structure in top-level README
parent 0313f1a3
No related branches found
No related tags found
No related merge requests found
......@@ -63,3 +63,10 @@ In your browser, access ``http://127.0.0.1:8000/`` and continue from there.
To update the setup to the current version on the main branch of the repository use the update script ``Utils/update.sh`` or ``Utils/update.sh --prod`` in production.
Afterwards, you may check your setup by executing ``Utils/check.sh`` or ``Utils/check.sh --prod`` in production.
## Structure
This repository contains a Django project called AKPlanning. The functionality is encapsulated into Django apps:
1. AKModel: This app contains the general Django models used to represent events, users, rooms, scheduling constraints etc. This app is a basic requirements for the other apps.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment