Skip to content

adithya-creation/CleanStreet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

119 Commits
Β 
Β 
Β 
Β 

Repository files navigation

🧹 Clean Street

A community-driven platform where citizens can report local civic issues, volunteers resolve them, and admins oversee everything β€” all in one place.

"Your one step can make our street spotless."


πŸš€ Features

  • πŸ“ Report Issues β€” Submit complaints with photo, priority, and GPS location
  • πŸ”„ Real-time Tracking β€” Follow complaint status from received β†’ in_review β†’ resolved
  • πŸ™‹ Volunteer System β€” Volunteers accept and resolve assigned complaints
  • πŸ—³οΈ Community Voting β€” Upvote/downvote issues to highlight urgency
  • πŸ’¬ Comments β€” Discuss issues on complaint threads
  • ⭐ Feedback & Ratings β€” Rate volunteers after resolution
  • πŸ”” Notifications β€” Alerts for assignments, status changes, and feedback
  • πŸ›‘οΈ Admin Dashboard β€” Manage users, complaints, feedback, and export reports

πŸ› οΈ Tech Stack

Frontend β€” React 19, Vite, Tailwind CSS, Framer Motion, React Router, Leaflet, Recharts, Axios

Backend β€” Node.js, Express.js, MongoDB, Mongoose, JWT, bcryptjs


βš™οΈ Getting Started

Prerequisites

  • Node.js v18+
  • MongoDB (local or Atlas)

1. Clone the repo

git clone https://github.com/your-username/clean-street.git
cd "clean-street"

2. Backend

cd backend
npm install
npm run dev       # http://localhost:5000

3. Frontend

cd frontend
npm install
npm run dev       # http://localhost:5173

πŸ” Environment Variables

backend/.env

PORT=5000
MONGO_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret

frontend/.env

VITE_API_URL=http://localhost:5000

πŸ‘₯ User Roles

Role Access
user Report issues, vote, comment, give feedback
volunteer Accept & resolve complaints, view own ratings
admin Full access β€” manage users, complaints, export reports

πŸ“„ License

This project is licensed under the MIT License.

About

CleanStreet is a platform where citizens can report and track civic issues, while volunteers work to resolve them.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages