Readme file upgradtion #33
Description
What Documentation is Needed?
The repository is missing frontend setup and start instructions.
There is no documentation explaining how to install dependencies, run the frontend locally, or what environment/prerequisites are required.
Specifically missing:
Frontend prerequisites (Node.js version, package manager)
Steps to install and run the frontend
Required environment variables (if any)
Local development server URL
This makes it difficult for contributors to run or contribute to the frontend.
Location
Where should this documentation be added or updated?
[**] README.md
[ ]CONTRIBUTING.md
[ ]API_DOCUMENTATION.md
[ ]Code comments/JSDoc
Other (please specify): ____________________
Current State
The README.md currently focuses on backend architecture and Docker-based setup.
However:
It does not mention the frontend/ directory
There are no instructions such as:
cd frontend
npm install
npm run dev
There is no mention of required Node.js version
Environment variables for the frontend (if required) are undocumented
The frontend dev server URL is not specified
Although a frontend/package.json exists, there is no guidance on how to use it.
Proposed Documentation
Add a “Frontend Setup” section to the README.md with the following structure: