[Feature]: Improve Readme Formatting and Structure

[Dippp10-ally]

Area

Documentation

Problem to solve

New contributors currently lack a proper CONTRIBUTING guide, and setup instructions are scattered across different files or inferred from source code. This makes onboarding confusing and time-consuming, especially for first-time contributors who need clear guidance on how to run the project locally.

Proposed solution

Improve project documentation by:

• Adding a CONTRIBUTING.md file with clear setup instructions.
• Including environment variable requirements for frontend and backend.
• Documenting run commands for both frontend and server.
• Adding linting, formatting, and build steps for consistency.
• Ensuring README aligns with actual scripts and project structure.
• Clearly separating frontend and backend setup instructions.

Who benefits and how?

• First-time contributors can set up the project quickly without needing to inspect source code.
• Maintainers spend less time answering repetitive setup questions.
• Overall onboarding experience becomes smoother and more structured.
• Reduces setup errors caused by missing or unclear environment documentation.

Scope or acceptance criteria

• README accurately reflects available scripts and commands.
• CONTRIBUTING.md is added and linked in README.
• Environment variables for frontend and backend are documented.
• Setup steps are clearly separated for frontend and server.
• Project can be set up by a new contributor using documentation alone

Related files, routes, or references

• frontend/src/App.jsx
• server/index.js
• README.md

Before submitting

• I checked for an existing issue that already covers this request.

[Dippp10-ally]

@0rigin-c0de ji , do assign above issue number 194 to me also.....do assign labels called as gssoc:approved , level:intermediate , type:docs , quality:exceptional to above issue number 194 also....

[Stewartsson]

Hi, I am a contributor under GSSoC'26 and would like to work on this issue. Could you please assign it to me as my system is ready to work on it