Add comprehensive README and .env.example files

[vinay1359]

The project currently lacks clear and complete documentation for setup and configuration, which makes it difficult for new contributors to get started.

Several key pieces of documentation are missing or incomplete, especially around environment configuration and backend setup.

Missing / Incomplete Documentation

README Improvements Needed

• Main README

  • Missing clear setup instructions
  • No quick start guide
  • Prerequisites and dependencies are not clearly listed

• Backend README

  • API endpoints are not documented
  • Backend dependencies are unclear
  • Configuration and environment setup is missing

Missing .env.example File

• No .env.example file exists in the backend directory
• Required environment variables (API keys, secrets, config values) are not documented
• New developers must guess which environment variables are needed and what they are used for

Suggested Solution

• Add a .env.example file in the backend directory containing:

  • All required environment variables
  • Dummy or placeholder values
  • Inline comments explaining the purpose of each variable

• Update the main README to include:

  • Quick start guide
  • Setup instructions for both frontend and backend
  • Required prerequisites and dependencies

• Improve the backend README by documenting:

  • API endpoints
  • Backend dependencies
  • Configuration steps

Benefits

• Easier onboarding for new contributors
• Reduced setup and troubleshooting time
• Fewer configuration-related issues
• Improved developer experience overall

@ParagGhatage Please assign this issue to me. I’d like to work on it.

[aditi25srivastava]

@vinay1359 Heyy!!!!! I would love to work on this issue. Could you please assign it to me ?

[Kaustubh1204]

Hi @vinay1359 👋
I’ve started auditing the current frontend and backend setup to identify required environment variables and missing setup docs.

I’ll open a PR soon with:

• A comprehensive root README with quick start steps
• A backend .env.example with documented variables
• Clear backend setup instructions based on the actual codebase

Open to feedback if there’s anything specific you want included.

[vinay1359]

Hi @aditi25srivastava and @Kaustubh1204,

I had requested a maintainer assigne this issue for me, but I haven’t received a response yet.

[Kaustubh1204]

Thanks for the update!
I’ll start working on the documentation improvements and share a draft PR soon so it can be reviewed.