Description
The current README provides a basic project title and tech stack, but it's missing clear instructions on how to set up and run the project locally.
Suggested Improvements
1.Add a "Getting Started" section to the README with steps like:
2.How to clone the repo
3.How to install dependencies
4.How to set up environment variables
5.How to run the development server
6. Optionally add a .env.example file
7.include a screenshot or demo GIF in README for better context
Why it's needed
New contributors (especially those in GSSoC) may find it hard to get started without setup instructions. This will make onboarding easier.
I would like to work on this issue as part of GSSoC 2025.
Description
The current README provides a basic project title and tech stack, but it's missing clear instructions on how to set up and run the project locally.
Suggested Improvements
1.Add a "Getting Started" section to the README with steps like:
2.How to clone the repo
3.How to install dependencies
4.How to set up environment variables
5.How to run the development server
6. Optionally add a
.env.examplefile7.include a screenshot or demo GIF in README for better context
Why it's needed
New contributors (especially those in GSSoC) may find it hard to get started without setup instructions. This will make onboarding easier.
I would like to work on this issue as part of GSSoC 2025.