Skip to content

Visualize system architecture, document CI/CD pipeline, and define database schema #6

@Nitya-003

Description

@Nitya-003

Description

The current README.md for StudyBuddy lists its features and installation steps but lacks technical depth regarding the cloud architecture and internal data relationships.

To lower the barrier for new contributors, we need to move from text descriptions to high-fidelity diagrams that explain how the application is containerized, deployed, and how data flows between users and study rooms.

Proposed Tasks

  1. Architecture Diagram: Create a Mermaid.js diagram illustrating the tech stack flow: GitHub Repo -> GitHub Actions -> Docker Hub -> Azure App Service.
  2. ER Diagram (Database Schema): Add a visual representation of the Django models. This should show the relationships between User, Room, Topic, and Message.
  3. CI/CD Workflow Documentation: Create a new file docs/DEPLOYMENT.md explaining the GitHub Actions workflow. Document the necessary secrets (Azure Credentials, Docker Login) required to fork and deploy the project.
  4. Environment Configuration Guide: Expand the installation section to include a template.env or a list of required Django settings (SECRET_KEY, DEBUG, ALLOWED_HOSTS).

Reasoning

  • Onboarding: New developers can't easily see how a "Message" is linked to a "Room" without digging into models.py. An ER diagram makes this instant.
  • DevOps Transparency: Since the project highlights "CI/CD" and "Azure," documenting the how is just as important as stating that it's there.
  • Contribution Quality: Clearer architectural docs lead to fewer broken PRs regarding database migrations or deployment configurations.

Labels
documentation enhancement good-first-issue ECWOC'26

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions