|
1 | 1 | # 🌟 **GitHub Tracker** 🌟 |
2 | 2 | <!-- top --> |
3 | 3 |
|
| 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 | + |
4 | 30 | **Track Activity of Users on GitHub** |
5 | 31 |
|
6 | 32 | 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 |
41 | 67 | --- |
42 | 68 |
|
43 | 69 | ## 🚀 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: |
45 | 74 | ```bash |
46 | | -$ git clone https://github.com/yourusername/github-tracker.git |
| 75 | +npm install |
47 | 76 | ``` |
48 | | - |
49 | | -2. Navigate to the project directory: |
| 77 | +Then in the backend folder: |
50 | 78 | ```bash |
51 | | -$ cd github-tracker |
| 79 | +cd backend |
| 80 | +npm install |
52 | 81 | ``` |
53 | 82 |
|
54 | | -3. Run the frontend |
| 83 | +### 2. Start the backend server |
| 84 | +In the `backend` folder: |
55 | 85 | ```bash |
56 | | -$ npm i |
57 | | -$ npm run dev |
| 86 | +npm start |
58 | 87 | ``` |
59 | 88 |
|
60 | | -4. Run the backend |
| 89 | +### 3. Start the frontend development server |
| 90 | +Open a new terminal in the project root: |
61 | 91 | ```bash |
62 | | -$ npm i |
63 | | -$ npm start |
| 92 | +npm run dev |
64 | 93 | ``` |
65 | 94 |
|
| 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 | +
|
66 | 100 | ## 🧪 Backend Unit & Integration Testing with Jasmine |
67 | 101 |
|
68 | 102 | This project uses the Jasmine framework for backend unit and integration tests. The tests cover: |
|
0 commit comments