/Fridgify_Documentation

This repository contains all files related to the documentation of Fridgify.

fridgify-doc

This repository contains all files related to the documentation of Fridgify.

The following README will guide you through this repository as well as give you an overview of every important file.

This document is going to be maintained constantly.

Structure

  1. Management Docs
    1. SRS
    2. SAD
    3. Risk Management & Use Case Durations
  2. Use Cases
    1. Overall Use Case Diagram
      1. Semester 1
      2. Semester 2
    2. Use Case Collection
      1. Manage Account
      2. Authentication
        1. Login
        2. Register
      3. Fridges
        1. Create Fridge
        2. FridgeContent
          1. Add Content
          2. Change Content Volume
          3. Get Content
          4. Remove Content
        3. Get Fridges
        4. Join Fridge
        5. Fridge User Management
        6. Remove Fridge
  3. Development Documentation
    1. API
      1. Endpoint Definition
      2. API-Workflows
        1. Authentication
        2. Register
        3. Create Fridge
        4. Fridge Content
        5. Get Fridges
        6. Fridge Roles
        7. Join Fridge
        8. Notification Service
    2. Database
      1. Database Model
      2. Table View
      3. ER-Diagram
      4. Class Diagram (Django)
      5. Up to Date Models
      6. SQL
    3. Continuous Integration / Continuous Delivery
      1. Deployment
  4. Hand-Ins
    1. Midterm
      1. Presentation
      2. Handout