From b33ea8e8d46ba081182b172b3cf97930401e772a Mon Sep 17 00:00:00 2001 From: Siddharam Date: Wed, 18 Jun 2025 11:29:27 +0530 Subject: [PATCH] Add Live Server extension setup steps --- README.md | 46 +++++++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index a79607c..5460204 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # 🧭 DevScope – HSSoC Contributor Dashboard

@@ -12,21 +11,20 @@

- ### 🌐 Live: [dev-scope.netlify.app](https://dev-scope.netlify.app) -> **DevScope** is a minimal, web-based GitHub contributor showcase built for the **HashSlap Summer of Code (HSSoC)**. It allows contributors to add their GitHub profiles and automatically displays their avatars, usernames, and **top programming languages** using GitHub’s public APIs. +> **DevScope** is a minimal, web-based GitHub contributor showcase built for the **HashSlap Summer of Code (HSSoC)**. It allows contributors to add their GitHub profiles and automatically displays their avatars, usernames, and **top programming languages** using GitHub's public APIs. --- ## ✨ Features -* πŸ” **Searchable Grid View** of all contributors -* 🧠 **Top Languages Analysis** using GitHub API -* πŸ–ΌοΈ Clean, terminal-inspired UI -* πŸ”§ No backend β€” built with HTML + JS + JSON -* ⚑ Fast & lightweight β€” deploys easily on Netlify/Vercel -* πŸ‘₯ Community-driven β€” contributors add themselves via `contributors.json` +- πŸ” **Searchable Grid View** of all contributors +- 🧠 **Top Languages Analysis** using GitHub API +- πŸ–ΌοΈ Clean, terminal-inspired UI +- πŸ”§ No backend β€” built with HTML + JS + JSON +- ⚑ Fast & lightweight β€” deploys easily on Netlify/Vercel +- πŸ‘₯ Community-driven β€” contributors add themselves via `contributors.json` --- @@ -47,18 +45,24 @@ cd dev-scope ``` -3. **Add your GitHub username** to the `contributors.json` file: +3. **Add your GitHub username** to the `contributors.json` file. We've successfully added "Siddhram" as an example! ```json - [ - "your-github-username", - "another-contributor" - ] + ["your-github-username", "another-contributor", "Siddhram"] ``` -4. **Commit and Push** +4. **Preview Your Changes Locally:** + + - Install the "Live Server" extension in VS Code (or your preferred code editor) + - Right-click on `src/index.html` and select "Open with Live Server" + - Your browser will automatically open with the preview + - No need to install Node.js or run any build tools! πŸŽ‰ + +5. **Update the screenshot (Optional but Recommended!):** Replace `assets/preview.png` with a new screenshot that includes your profile card. This makes your contribution visible directly in the README. + +6. **Commit and Push** -5. **Create a Pull Request** +7. **Create a Pull Request** Once merged, your profile will appear on the website within minutes! @@ -66,10 +70,10 @@ Once merged, your profile will appear on the website within minutes! ## 🧰 Tech Stack -* HTML / CSS / JavaScript -* GitHub REST API v3 -* JSON-based contributor input -* Deployed on **Netlify** +- HTML / CSS / JavaScript +- GitHub REST API v3 +- JSON-based contributor input +- Deployed on **Netlify** --- @@ -81,7 +85,7 @@ This project was born out of the desire to give HSSoC contributors a **simple ye ## πŸ‘¨β€πŸ’» Made With ❀️ for HSSoC - DevScope is an open-source effort by the HashSlap Summer of Code community. Contributions, feedback, and stars are always welcome! +DevScope is an open-source effort by the HashSlap Summer of Code community. Contributions, feedback, and stars are always welcome! ---