Merge branch 'main' into fix-auth-navbar

Author: mehul-m-prajapati

.github/workflows/auto-label-gssoc.yml

@@ -27,4 +27,5 @@ jobs:
         labels: |
             level:intermediate
             quality:clean
+            type:accessibility
             gssoc:approved

README.md

@@ -41,28 +41,194 @@ Welcome to **GitHub Tracker**, a web app designed to help you monitor and analyz
 ---
 
 ## 🚀 Setup Guide
-1. Clone the repository to your local machine:
+
+### 📋 Prerequisites
+
+Before setting up the project locally, ensure the following tools are installed on your system:
+
+- Node.js (v18 or later recommended)
+- npm
+- Docker
+- Docker Compose
+- MongoDB (required for backend services and testing)
+
+---
+
+## 📥 Clone the Repository
+
+```bash
+git clone https://github.com/GitMetricsLab/github_tracker.git
+cd github-tracker
+```
+
+---
+
+# 💻 Local Development Setup
+
+This project contains both frontend and backend services.
+
+## ▶️ Frontend Setup
+
+Install frontend dependencies:
+
+```bash
+npm install
+```
+
+Start the frontend development server:
+
+```bash
+npm run dev
+```
+
+The frontend will run on:
+
+```txt
+http://localhost:5173
+```
+
+---
+
+## ⚙️ Backend Setup
+
+Move into the backend directory:
+
 ```bash
-$ git clone https://github.com/yourusername/github-tracker.git
+cd backend
 ```
 
-2. Navigate to the project directory:
+Install backend dependencies:
+
 ```bash
-$ cd github-tracker
+npm install
 ```
 
-3. Run the frontend
+Start the backend server:
+
 ```bash
-$ npm i
-$ npm run dev
+npm run dev
+```
+
+The backend server will run on:
+
+```txt
+http://localhost:5000
 ```
 
-4. Run the backend
+---
+
+# 🐳 Docker Development Workflow
+
+The project includes Docker configurations for both development and production environments.
+
+## 📦 Development Environment
+
+Run the complete development environment using Docker:
+
 ```bash
-$ npm i
-$ npm start
+npm run docker:dev
 ```
 
+This command:
+
+- Builds frontend and backend containers
+- Starts development services
+- Enables live file changes using Docker volumes
+- Runs frontend and backend simultaneously
+
+### Development Services
+
+| Service | Port |
+|----------|------|
+| Frontend | 5173 |
+| Backend | 5000 |
+
+---
+
+## 🚀 Production Environment
+
+Run the production Docker setup:
+
+```bash
+npm run docker:prod
+```
+
+This command:
+
+- Creates optimized production builds
+- Runs frontend using Nginx
+- Starts backend production services
+
+### Production Services
+
+| Service | Port |
+|----------|------|
+| Frontend | 3000 |
+| Backend | 5000 |
+
+---
+
+# 📂 Docker Configuration Overview
+
+| File | Purpose |
+|------|----------|
+| `Dockerfile.dev` | Development container setup |
+| `Dockerfile.prod` | Production container setup |
+| `docker-compose.yml` | Multi-service container orchestration |
+
+---
+
+# 🔄 Local Development Workflow
+
+Recommended contributor workflow:
+
+1. Fork the repository
+2. Clone your fork locally
+3. Create a new branch
+4. Install dependencies
+5. Run frontend/backend locally or using Docker
+6. Make changes
+7. Test your implementation
+8. Commit and push changes
+9. Open a Pull Request
+
+---
+
+# 🌱 Environment Configuration
+
+The project uses environment variables for configuration.
+
+Frontend environment variables:
+
+```env
+VITE_BACKEND_URL=http://localhost:5000
+```
+
+Backend environment variables:
+
+```env
+PORT=5000
+MONGO_URI=your_mongodb_connection
+SESSION_SECRET=your_secret
+```
+
+Create corresponding `.env` files before running the application.
+
+---
+
+# 🛠️ Useful Commands
+
+| Command | Description |
+|----------|-------------|
+| `npm run dev` | Start frontend locally |
+| `npm run build` | Create production build |
+| `npm run docker:dev` | Run Docker development environment |
+| `npm run docker:prod` | Run Docker production environment |
+| `npm run test` | Run frontend tests |
+| `npm run test:backend` | Run backend tests |
+
+---
+
 ## 🧪 Backend Unit & Integration Testing with Jasmine
 
 This project uses the Jasmine framework for backend unit and integration tests. The tests cover:
@@ -140,3 +306,6 @@ spec_files: [
     ⬆️ Back to Top
   </a>
 </p>
+
+
+

backend/server.js

@@ -14,7 +14,17 @@ const logger = require('./logger');
 const app = express();
 
 // CORS configuration
-app.use(cors('*'));
+const allowedOrigins = ['http://localhost:5173', 'https://github-spy.etlify.app'];
+app.use(cors({
+    origin: function (origin, callback) {
+        if (!origin || allowedOrigins.indexOf(origin) !== -1) {
+            callback(null, true);
+        } else{
+            callback(new Error('Blocked by CORS policy'));
+        }
+    },
+    credentials: true
+}));
 
 // Middleware
 app.use(bodyParser.json());
@@ -33,8 +43,10 @@ app.use('/api/auth', authRoutes);
 // Connect to MongoDB
 mongoose.connect(process.env.MONGO_URI, {}).then(() => {
     logger.info('Connected to MongoDB');
-    app.listen(process.env.PORT, () => {
-        logger.info(`Server running on port ${process.env.PORT}`);
+
+    const PORT = process.env.PORT || 5000;
+    app.listen(PORT, () => {
+        logger.info(`Server running on port ${PORT}`);
     });
 }).catch((err) => {
     logger.error('MongoDB connection error', err);

index.html

@@ -4,6 +4,9 @@
     <meta charset="UTF-8" />
     <link rel="icon" type="image/svg+xml" href="/crl-icon.png" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+    <link href="https://fonts.googleapis.com/css2?family=VT323&display=swap" rel="stylesheet" />
     <title>Github Tracker</title>
   </head>
   <body>

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "GitHub Tracker",
+  "name": "github-tracker",
   "private": true,
   "version": "0.0.0",
   "type": "module",

src/Routes/Router.tsx

@@ -8,6 +8,7 @@ import Login from "../pages/Login/Login.tsx";
 import ContributorProfile from "../pages/ContributorProfile/ContributorProfile.tsx";
 import Home from "../pages/Home/Home.tsx";
 import Activity from "../pages/Activity.tsx"; 
+import PrivacyPolicy from "../pages/Privacy/PrivacyPolicy.tsx"; // ✅ Updated import path to match your new folder structure
 
 const Router = () => {
   return (
@@ -20,9 +21,10 @@ const Router = () => {
       <Route path="/contact" element={<Contact />} />
       <Route path="/contributors" element={<Contributors />} />
       <Route path="/contributor/:username" element={<ContributorProfile />} />
-
-      {/* ✅ new route */}
       <Route path="/activity" element={<Activity />} />
+
+      {/* Privacy Policy page route */}
+      <Route path="/privacy" element={<PrivacyPolicy />} />
     </Routes>
   );
 };