Improve and expand project documentation

[harshika53]

The current project documentation can be improved to make it easier for new contributors to understand and get started.

Tasks:

• Improve README clarity and formatting
• Add detailed setup instructions (frontend + backend)
• Add screenshots or demo explanation
• Explain project structure clearly
• Add usage examples

Expected Outcome:
A well-structured and beginner-friendly documentation that helps contributors quickly understand and work on the project.

[faridakhaled05]

Hi @harshika53! I'd love to work on this issue. I plan to:

Add 2-3 additional screenshots showing the scan results page, reports page, and an accessibility issue breakdown
Expand the MongoDB setup section with a step-by-step guide on how to create a free MongoDB Atlas cluster and get the connection string
Improve the environment variables section to explain what MONGO_URI is, where to get it, and what format it should be in

Can I be assigned to this issue? Thank you!

[harshika53]

Hi @faridakhaled05, thank you for your interest in this issue! 🙌

Your plan looks great and aligns well with what we need. I've assigned this issue to you.

Feel free to:

• Follow the existing project structure
• Keep the README clean and well-structured
• Add clear steps and screenshots with proper headings and formatting

Let me know if you need any clarification. Looking forward to your contribution! 🚀

[harshika53]

Hi @faridakhaled05
Just following up regarding this issue. Since there has been no recent activity, please confirm if you are still planning to work on it. If I don’t hear back soon, I’ll keep the issue open for other contributors to take up. Thanks!

[faridakhaled05]

Hi @harshika53, so sorry for the delay! Life got in the way but I’m still planning to work on this — please give me a little more time! 🙏

[harshika53]

Hi @faridakhaled05,

Thanks for letting us know. Since there hasn’t been further progress and we need to keep the documentation work moving, I’ll go ahead and keep this issue open for other contributors to pick up. If you’d still like to work on it later, feel free to comment again.

[vishakhaojha57]

hiii, i wanna work on this can i be assigned ?