Skip to content

[Fix] README formatting and improve backend setup documentation #509

Closed

Description

@arpit2006

Description

Problem

The current README contains several formatting inconsistencies and incomplete setup instructions which may create confusion for new contributors and users trying to run the project locally.

Issues Identified

  • Mermaid architecture diagram is not properly wrapped inside a Markdown Mermaid block, causing it to render as plain text on GitHub.

  • Project structure tree formatting is inconsistent in some sections.

  • Backend setup documentation is incomplete:

    • Missing virtual environment setup instructions
    • Missing dependency installation steps
    • Missing Flask backend run command
    • Missing .env configuration guidance
  • Some unnecessary development-related files/folders may require cleanup or clarification.

Expected Improvements

  • Properly render Mermaid diagrams using:
graph TD
A[Frontend] --> B[Backend]
B --> C[Database]
Loading
  • Fix project structure formatting for improved readability.

  • Add detailed backend setup instructions including:

    • Creating and activating a virtual environment
    • Installing dependencies
    • Running the backend server
    • Setting up environment variables
  • Review unnecessary development artifacts and improve repository cleanliness if required.

Benefits

  • Improves onboarding experience for new contributors
  • Makes local project setup easier and more beginner-friendly
  • Enhances repository readability and documentation quality
  • Maintains better project consistency and professionalism

Additional Context

I would like to work on this issue under GSSoC and contribute to improving the project documentation and developer experience.
Kindly assign this issue to me, @devanshi14malhotra .

Activity

  1. devanshi14malhotra commented on May 14, 2026

    @devanshi14malhotra
    Owner

    @arpit2006 the mermaid diagrams are properly rendered in the readme, as far as i can see...
    but the readme is too long... and the contributing.md link is broken too, and needs to be updated...
    so u can include these improvements as part of ur issue's pr...

  2. added
    documentationImprovements or additions to documentation
    level:beginnerGSSoC'26 beginner level PR/issue
    type:docsAdditions or updates to documentation (for GSSoC'26)
    GSSoC'26For all issues/PRs related to GSSoC'2026 open source event
    on May 15, 2026
  3. vinitabalotiya commented on May 16, 2026

    @vinitabalotiya

    Hi, I would like to work on this issue under GSSoC 2026. Please assign this issue to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

GSSoC'26For all issues/PRs related to GSSoC'2026 open source eventdocumentationImprovements or additions to documentationgood first issueGood for newcomerslevel:beginnerGSSoC'26 beginner level PR/issuetype:docsAdditions or updates to documentation (for GSSoC'26)

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions