Skip to content

Add Live Server extension setup steps #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add Live Server extension setup steps #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b33ea8e
Add Live Server extension setup steps
Siddhram Jun 18, 2025
ca10287
Merge branch 'main' into update-getting-started-live-server
Siddhram Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 25 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@

### 🌐 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`

---

Expand Down Expand Up @@ -87,17 +87,23 @@
cd dev-scope
```

3. **Add your GitHub username** to the `contributors.json` file:

```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!

Expand All @@ -111,10 +117,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**

---

Expand All @@ -126,7 +132,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!

---

Expand Down