Civix:Civic Issue Reporting and Tracking App

1. Clone the repository

git clone https://github.com/YOUR_USERNAME/Civix.git

2. Navigate to the project directory

cd Civix

3. Install frontend dependencies

cd client

npm install

4. Install backend dependencies

cd ../server

npm install

5. Configure environment variables

Create a `.env` file inside the server directory and configure:

PORT=5000

DB_HOST=localhost

DB_USER=your_mysql_username

DB_PASSWORD=your_mysql_password

DB_NAME=civix

JWT_SECRET=your_jwt_secret_key

6. Create the MySQL database

Import the provided SQL schema or create the required tables.

7. Start the backend server

npm start

or

npm run dev

8. Start the frontend

Open a new terminal:

cd client

npm start

or

npm run dev

9. Open the application

Visit:

http://localhost:3000

or

http://localhost:5173

10. Login or Register

Create an account and begin reporting, tracking, and managing civic issues.

User Guide

1. Open the application in your web browser.
2. Register a new account or log in using your existing credentials.
3. After logging in, access the dashboard to view your reported issues and recent activity.
4. Click Report Issue to submit a new civic complaint.

• Enter the issue title and description.
• Select the issue type and priority.
• Provide the address or nearby landmark.
• Pin the exact location using the interactive map.
• Upload an image of the issue (if supported).
• Submit the complaint.

1. Monitor the status of submitted complaints through the View Complaints section. Complaint statuses such as Received, In Review, and Resolved are updated by administrators.
2. Browse community-reported issues, upvote important complaints, and leave comments to encourage faster resolution.
3. Update your personal information from the Profile page whenever necessary.
4. Administrators can access the Admin Dashboard to:

• View all reported complaints.
• Manage users.
• Assign or update complaint statuses.
• Monitor platform activity.
• Review reports and analytics.

1. All user sessions are secured using JWT authentication, and role-based access ensures that users only access features permitted for their role.
2. Log out after completing your work to maintain account security.

Expected Output

• Citizens can efficiently report and track civic issues.
• Administrators can manage complaints through a centralized dashboard.
• Community members can participate by voting and commenting on reports.
• The platform provides a transparent workflow from issue reporting to final resolution.
• Interactive maps improve location accuracy, enabling faster response from authorities.

Hardware Requirements

• Processor: Intel Core i3 (8th Generation or higher) / AMD Ryzen 3 or equivalent
• RAM: Minimum 4 GB (8 GB Recommended)
• Storage: Minimum 2 GB free disk space
• Internet Connection: Required for API communication, map services, and package installation

Software Requirements

• Operating System:
• Windows 10/11
• Ubuntu 20.04+ / Other Linux distributions
• macOS 11 or later
• Runtime Environment:
• Node.js v18 or later
• npm v9 or later
• Database:
• MySQL 8.0 or later
• Development Tools:
• Visual Studio Code (Recommended)
• Git
• GitHub
• Web Browser:
• Google Chrome (Recommended)
• Microsoft Edge
• Mozilla Firefox
• Safari

Required Packages & Libraries

• React.js
• Node.js
• Express.js
• MySQL
• JWT (JSON Web Token)
• Tailwind CSS
• Leaflet.js
• OpenStreetMap
• Axios
• Express Router
• dotenv
• bcryptjs
• cors
• multer (if image uploads are supported)

Environment Configuration

• Node.js and npm installed
• MySQL Server running
• Project dependencies installed using npm install
• .env file configured with:
• Database credentials
• JWT Secret
• Server Port
• API configuration

Recommended Development Environment

• VS Code with ESLint and Prettier extensions
• Git for version control
• Postman for REST API testing
• MySQL Workbench for database management