Skip to content

[DOC-01] Complete README, API documentation and demo guide #37

Closed
Closed
[DOC-01] Complete README, API documentation and demo guide#37
Assignees
Krisor1986

Description

@Krisor1986
Krisor1986
opened on Sep 9, 2026

Goal

Prepare the technical and presentation material for the final project.

Tasks

  • Document local installation
  • Document environment variables
  • Document database migrations
  • Document core API endpoints
  • Link architecture and ERD files
  • Add demo credentials and presentation flow
  • List known limitations

Acceptance criteria

  • A new developer can run the project from the README
  • The professor can understand the architecture and main flows
  • The team has a repeatable demo script

Activity

  1. Krisor1986
    self-assigned this
    on Sep 20, 2026
  2. Krisor1986
    closed this as completedon Sep 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions