First Iteration of a Documentation on Hephaestus

[GODrums]

Objective

With the increase in complexity of our code, we require a explicit documentation to prevent information loss and preserve good coding standards.

Hephaestus docs: https://ls1intum.github.io/Hephaestus/
Artemis docs: https://docs.artemis.cit.tum.de/

Tasks

• Setup guide -> Docs: Setup Guide Page #213
  • Server setup:
    • application-local.yml - which values exist and what do they change?
    • MVN / NPM commands
  • Client setup
• Coding and Design guidelines
  • Server
  • Client
  • Database
• System Design
  • TLD
  • Data Model
  • Deployment?
• Data Migration (Liquibase)