CivicBridge 🚀

Open Platform for Discovering Public Schemes and Reporting Civic Issues

being built by Abhishek Dige,Parth Badgire and Smit Jain CivicBridge is a civic-tech platform that helps citizens:

• Discover government schemes they are eligible for
• Report civic issues like potholes, garbage dumps, and broken infrastructure
• View issues transparently on a public map

The goal is to improve awareness, transparency, and community participation.

---

🏗 Project Architecture

Frontend

• React
• Vite

Backend

• Node.js
• Express.js

Database & Auth

• Supabase

---

## Project Structure
civicbridge/
│
├── README.md
├── .env
├── .gitignore
│
├── frontend/
│   ├── public/
│   │   └── logo.svg
│   │
│   ├── src/
│   │   ├── assets/
│   │   │   ├── images/
│   │   │   └── icons/
│   │   │
│   │   ├── components/
│   │   │   ├── Navbar.jsx
│   │   │   ├── Footer.jsx
│   │   │   ├── SchemeCard.jsx
│   │   │   ├── IssueCard.jsx
│   │   │   └── MapComponent.jsx
│   │   │
│   │   ├── pages/
│   │   │   ├── Home.jsx
│   │   │   ├── SchemeNavigator.jsx
│   │   │   ├── ReportIssue.jsx
│   │   │   ├── IssueMap.jsx
│   │   │   ├── Login.jsx
│   │   │   └── Dashboard.jsx
│   │   │
│   │   ├── services/
│   │   │   ├── api.js
│   │   │   ├── schemeService.js
│   │   │   └── issueService.js
│   │   │
│   │   ├── hooks/
│   │   │   └── useAuth.js
│   │   │
│   │   ├── utils/
│   │   │   ├── filterSchemes.js
│   │   │   └── constants.js
│   │   │
│   │   ├── styles/
│   │   │   └── global.css
│   │   │
│   │   ├── App.jsx
│   │   └── main.jsx
│   │
│   └── package.json
│
│
├── backend/
│   ├── src/
│   │
│   │   ├── controllers/
│   │   │   ├── schemeController.js
│   │   │   └── issueController.js
│   │   │
│   │   ├── routes/
│   │   │   ├── schemeRoutes.js
│   │   │   └── issueRoutes.js
│   │   │
│   │   ├── services/
│   │   │   ├── schemeService.js
│   │   │   └── issueService.js
│   │   │
│   │   ├── middleware/
│   │   │   └── authMiddleware.js
│   │   │
│   │   ├── config/
│   │   │   └── supabaseClient.js
│   │   │
│   │   ├── utils/
│   │   │   └── helpers.js
│   │   │
│   │   └── server.js
│   │
│   └── package.json
│
│
├── database/
│   ├── schema.sql
│   └── seedData.json
│
│
├── docs/
│   ├── architecture.md
│   └── api.md
│
│
└── scripts/
    └── seedDatabase.js

🧭 Team Git Workflow (Step-by-Step) 1️⃣ Clone the Repository (First Time Only)

Each teammate does this once.

git clone <repo - link> cd civicbridge

Now the project exists on their computer.

2️⃣ Always Pull Latest Code Before Starting Work

Before doing any work, sync with the latest main.

git checkout main git pull origin main

This ensures you are working on the latest version of the project.

🚀 Project Setup (For Contributors)

Follow these steps to run the project locally.

1️⃣ Clone the Repository

git clone <repo-url>
cd civicbridge

---

2️⃣ Setup Frontend

Navigate to the frontend folder and install dependencies.

cd frontend
npm install

Run the development server:

npm run dev

Frontend will run at:

http://localhost:5173

---

3️⃣ Setup Backend

Open a new terminal and navigate to the backend folder.

cd backend
npm install

---

4️⃣ Create Environment Variables

Inside the backend folder, create a .env file.

Example:

SUPABASE_URL=your_supabase_project_url
SUPABASE_KEY=your_supabase_anon_key
PORT=5000

Ask the team lead for the Supabase credentials.

---

5️⃣ Start Backend Server

Run the backend:

npm run dev

Backend will run at:

http://localhost:5000

---

6️⃣ Running the Full Project(not required if you are only working on frontend)

You should now have two terminals running:

Terminal 1 (frontend)

cd frontend
npm run dev

Terminal 2 (backend)

cd backend
npm run dev

---

⚠️ Important Notes

• Do not commit .env files
• Always pull latest changes before starting work

git pull origin main

• Work on feature branches, not directly on main

3️⃣ Create a Feature Branch

Never work on main.

Create a branch for your task.

Example:

git checkout -b feature/navbar

Other examples:

feature/scheme-navigator feature/report-issue feature/map-system feature/backend-api

Now you are working safely in your own branch.

4️⃣ Work on Your Feature

Edit files normally.

Example:

src/components/Navbar.jsx 5️⃣ Stage and Commit Changes

When you complete a logical piece of work:

git add . git commit -m "Add navbar component"

Good commit messages:

Add scheme navigator form Implement issue reporting API Fix navbar routing

Avoid:

update stuff changes 6️⃣ Push Your Feature Branch

Upload your branch to GitHub.

git push origin feature/navbar

Now the branch appears on GitHub.

7️⃣ Create a Pull Request (PR)

Go to the repository on GitHub.

You will see:

Compare & Pull Request

Create PR:

feature/navbar → main

This means:

“Please merge my feature into the main branch.”

8️⃣ Review and Merge

Someone checks the code.

If everything is fine:

Click Merge Pull Request.

Now the main branch updates.

9️⃣ Everyone Syncs After Merge

After a PR merges, everyone should update their local repo.

git checkout main git pull origin main

Now everyone has the updated code.

🔁 Daily Workflow (Short Version)

Every day your team follows this:

git checkout main git pull origin main git checkout -b feature/your-feature

Work → commit → push → PR.

📦 Core Features

1️⃣ Scheme Navigator

Users enter basic details:

• Age
• Income
• State
• Education
• Occupation
• Category

System filters and recommends eligible government schemes.

Output shows:

• Scheme name
• Description
• Eligibility criteria
• Benefits
• Application link

---

2️⃣ Civic Issue Reporter

Citizens can report local issues.

Fields:

• Photo upload
• Issue type
• Description
• Location

Issues appear on a public map for transparency.

Issue Types:

• Pothole
• Garbage
• Water leakage
• Broken streetlight
• Road damage

---

🗂 Database Schema

Schemes Table

id
name
description
income_limit
age_limit
category
state
link

Issues Table

id
title
description
latitude
longitude
photo_url
status
created_at

Users Table

id
name
email
role

---

🚀 Future Improvements

Possible extensions:

• Government API integration
• Issue voting system
• Civic analytics dashboard
• Mobile app
• Community moderation

---