Skip to content

Commit b9e6ef3

Browse files
committed
docs: add Quick Start for Contributors and clarify setup steps
1 parent cda5a3a commit b9e6ef3

1 file changed

Lines changed: 45 additions & 11 deletions

File tree

README.md

Lines changed: 45 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11
# 🌟 **GitHub Tracker** 🌟
22
<!-- top -->
33

4+
## 🚩 Quick Start for Contributors
5+
6+
Want to contribute? Here’s how to get started:
7+
8+
1. **Fork** this repository on GitHub.
9+
2. **Clone** your fork:
10+
```bash
11+
git clone https://github.com/<your-username>/github_tracker.git
12+
cd github_tracker
13+
```
14+
3. **Create a new branch** for your change:
15+
```bash
16+
git checkout -b my-first-contribution
17+
```
18+
4. **Make your changes** (e.g., edit `README.md` to improve instructions).
19+
5. **Commit and push**:
20+
```bash
21+
git add .
22+
git commit -m "docs: improve README instructions"
23+
git push origin my-first-contribution
24+
```
25+
6. **Open a Pull Request** from your branch to the main repository.
26+
27+
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more details!
28+
29+
430
**Track Activity of Users on GitHub**
531

632
Welcome to **GitHub Tracker**, a web app designed to help you monitor and analyze the activity of GitHub users. Whether you’re a developer, a project manager, or just curious, this tool simplifies tracking contributions and activity across repositories! 🚀👩‍💻
@@ -41,28 +67,36 @@ Welcome to **GitHub Tracker**, a web app designed to help you monitor and analyz
4167
---
4268

4369
## 🚀 Setup Guide
44-
1. Clone the repository to your local machine:
70+
71+
### 1. Install dependencies for both frontend and backend
72+
73+
In the project root:
4574
```bash
46-
$ git clone https://github.com/yourusername/github-tracker.git
75+
npm install
4776
```
48-
49-
2. Navigate to the project directory:
77+
Then in the backend folder:
5078
```bash
51-
$ cd github-tracker
79+
cd backend
80+
npm install
5281
```
5382

54-
3. Run the frontend
83+
### 2. Start the backend server
84+
In the `backend` folder:
5585
```bash
56-
$ npm i
57-
$ npm run dev
86+
npm start
5887
```
5988

60-
4. Run the backend
89+
### 3. Start the frontend development server
90+
Open a new terminal in the project root:
6191
```bash
62-
$ npm i
63-
$ npm start
92+
npm run dev
6493
```
6594

95+
### 4. Open the app in your browser
96+
Visit the URL shown in the terminal (usually http://localhost:5173).
97+
98+
> **Note:** Make sure MongoDB is running locally (default: `mongodb://127.0.0.1:27017`).
99+
66100
## 🧪 Backend Unit & Integration Testing with Jasmine
67101

68102
This project uses the Jasmine framework for backend unit and integration tests. The tests cover:

0 commit comments

Comments
 (0)