docs: enhance README with structured sections and project clarity#122
Conversation
|
Thank you for submitting a pull request. Please ensure your changes comply with the project's contribution guidelines and that all workflow checks pass successfully. A maintainer will review your submission shortly. |
jagdish-15
left a comment
jagdish-15
left a comment
There was a problem hiding this comment.
Please commit all of the suggestions below.
Also, replace the current Usage and How to Run Locally sections with the following, exactly as provided below (including the order change):
## Usage
The platform is publicly available at:
`https://codepvg.onrender.com`
Students can register using their LeetCode username to participate in the leaderboard, track rankings across different leaderboard views, monitor historical performance, and compare progress with other users.
Leaderboard data is synchronised periodically, so newly registered users and recent submissions may take a few minutes to appear in the rankings.
---
## How to Run Locally
```bash
git clone https://github.com/YOUR-USERNAME/leetcode-ranking.git
cd leetcode-ranking
npm install
npm run dev
```
Then open the frontend locally in your browser after starting the server.
For detailed development setup, sync workflow testing, contribution guidelines, and local data repository configuration, refer to `CONTRIBUTING.md`.And please remove the older version of the Contributing section as well after committing the updated version provided below
|
/format |
|
I have successfully run Prettier and pushed the formatting fixes to this PR. Note for Contributors: Because this commit was pushed by a bot, GitHub will not automatically re-run the CI checks. To trigger them to pass, you must either:
|
jagdish-15
added
type:docs
2 participants
Description
This PR improves the README.md by restructuring and enhancing documentation to make the project more developer-friendly and easier to understand for new contributors.
It adds clearer explanations of the project architecture, data flow, setup instructions, and overall usage while keeping the documentation clean and concise.
Linked Issue
Fixes #119
Changes Made
Type of Change
Testing
Checklist
Screenshots / Screen Recording
Not applicable (documentation-only changes)