Added detailed README with features and setup#11
Added detailed README with features and setup#11adityak-06 wants to merge 2 commits intocodepvg:mainfrom
Conversation
jagdish-15
left a comment
jagdish-15
left a comment
There was a problem hiding this comment.
Thanks for taking this up. Here are a few suggested changes:
|
|
||
| --- | ||
|
|
||
| ## Features |
There was a problem hiding this comment.
Let’s avoid including a features section in the README, so we don’t have to keep updating it every time new features are added.
| # leetcode-ranking No newline at end of file | ||
| # CodePVG LeetCode Ranking | ||
|
|
||
| A web-based platform developed for CodePVG to track and rank students based on their LeetCode performance. |
There was a problem hiding this comment.
| A web-based platform developed for CodePVG to track and rank students based on their LeetCode performance. | |
| A web-based platform developed by [CodePVG](https://www.linkedin.com/company/codepvg/) to track and rank students of [PVG COET](https://www.pvgcoet.ac.in/) based on their LeetCode performance. |
|
|
||
| --- | ||
|
|
||
| ## Tech Stack |
There was a problem hiding this comment.
We already get a summary of the tech stack on the main repo page, so instead of repeating that in the README, we can link the related repos for the backend and the web scraping API (since LeetCode doesn’t officially provide one):
This would be more useful and avoid redundancy
| │── frontend/ # UI (HTML, CSS, JS) | ||
| │── data/ # Stored user data | ||
| │── scripts/ # Automation scripts | ||
| │── server.js # Backend server |
There was a problem hiding this comment.
| │── server.js # Backend server | |
| │── server.js # Express server |
| 1. Open the registration page | ||
| 2. Enter your name and LeetCode username | ||
| 3. Submit the form | ||
| 4. View your ranking on the leaderboard |
There was a problem hiding this comment.
| 4. View your ranking on the leaderboard | |
| 4. View your ranking on the leaderboard after the next sync |
|
|
||
| npm install | ||
| cd frontend | ||
| npm install |
There was a problem hiding this comment.
| npm install | |
| cd frontend | |
| npm install | |
| `npm install` |
|
|
||
| npm run dev | ||
|
|
||
| or | ||
|
|
||
| node server.js |
There was a problem hiding this comment.
| npm run dev | |
| or | |
| node server.js | |
| `npm run dev` | |
| or | |
| `npm start` |
2 participants
📄 README Enhancement
This PR adds a detailed and structured README.md to improve project understanding for new users and contributors.
✨ Changes Made
🎯 Impact
Closes #5