From ffd220ce6b995ae123333b70cc786edfd75a24a9 Mon Sep 17 00:00:00 2001 From: sourav kumar Date: Tue, 19 May 2026 01:20:23 +0530 Subject: [PATCH] Revise README content and structure Updated README to enhance clarity and formatting. --- README.md | 153 +++++++++++------------------------------------------- 1 file changed, 30 insertions(+), 123 deletions(-) diff --git a/README.md b/README.md index a747b53..7e29d1b 100644 --- a/README.md +++ b/README.md @@ -1,142 +1,49 @@ -# 🌟 **GitHub Tracker** 🌟 +# 🌟 GitHub Tracker 🌟 -**Track Activity of Users on GitHub** +**Track GitHub User Activity Effortlessly** -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! πŸš€πŸ‘©β€πŸ’» +Welcome to **GitHub Tracker**, a web application designed to help you monitor and analyze GitHub user activity in a simple and efficient way. +Whether you’re a developer, project manager, or just curious about contributions, this tool makes tracking repositories and activity seamless. πŸš€πŸ‘©β€πŸ’»

- github-tracker + github-tracker

+ - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
🌟 Stars🍴 ForksπŸ› IssuesπŸ”” Open PRsπŸ”• Close PRs
StarsForksIssuesOpen Pull RequestsClosed Pull Requests
🌟 Stars🍴 ForksπŸ› IssuesπŸ”” Open PRsπŸ”• Closed PRs
StarsForksIssuesOpen PRsClosed PRs
--- ## πŸ› οΈ Tech Stack -- **Frontend**: React.js + Vite -- **Styling**: TailwindCSS + Material UI -- **Data Fetching**: Axios + React Query -- **Backend**: Node.js + Express +- **Frontend:** React.js + Vite +- **Styling:** TailwindCSS + Material UI +- **Data Fetching:** Axios + React Query +- **Backend:** Node.js + Express --- ## πŸš€ Setup Guide -1. Clone the repository to your local machine: -```bash -$ git clone https://github.com/yourusername/github-tracker.git -``` - -2. Navigate to the project directory: -```bash -$ cd github-tracker -``` -3. Run the frontend +### 1. Clone the repository ```bash -$ npm i -$ npm run dev -``` - -4. Run the backend -```bash -$ npm i -$ npm start -``` - -## πŸ§ͺ Backend Unit & Integration Testing with Jasmine - -This project uses the Jasmine framework for backend unit and integration tests. The tests cover: -- User model (password hashing, schema, password comparison) -- Authentication routes (signup, login, logout) -- Passport authentication logic (via integration tests) - -### Prerequisites -- **Node.js** and **npm** installed -- **MongoDB** running locally (default: `mongodb://127.0.0.1:27017`) - -### Installation -Install all required dependencies: -```sh -npm install -npm install --save-dev jasmine @types/jasmine supertest express-session passport passport-local bcryptjs -``` - -### Running the Tests -1. **Start MongoDB** (if not already running): - ```sh - mongod - ``` -2. **Run Jasmine tests:** - ```sh - npx jasmine - ``` - -### Test Files -- `spec/user.model.spec.cjs` β€” Unit tests for the User model -- `spec/auth.routes.spec.cjs` β€” Integration tests for authentication routes - -### Jasmine Configuration -The Jasmine config (`spec/support/jasmine.mjs`) is set to recognize `.cjs`, `.js`, and `.mjs` test files: -```js -spec_files: [ - "**/*[sS]pec.?(m)js", - "**/*[sS]pec.cjs" -] -``` - -### Troubleshooting -- **No specs found:** Ensure your test files have the correct extension and are in the `spec/` directory. -- **MongoDB connection errors:** Make sure MongoDB is running and accessible. -- **Missing modules:** Install any missing dev dependencies with `npm install --save-dev `. - -### What Was Covered -- Jasmine is set up and configured for backend testing. -- All major backend modules are covered by unit/integration tests. -- Tests are passing and verified. - ---- - -[![Star History Chart](https://api.star-history.com/svg?repos=GitMetricsLab/github_tracker&type=Date)](https://www.star-history.com/#GitMetricsLab/github_tracker&Date) - ---- - -# πŸ‘€ Our Contributors - -- We extend our heartfelt gratitude for your invaluable contribution to our project. -- Make sure you show some love by giving ⭐ to our repository. - -
- - - -
- - - ---- - -

- - ⬆️ Back to Top - -

+git clone https://github.com/yourusername/github-tracker.git