Skip to content

README.md

Latest commit

 

History

History
101 lines (65 loc) · 2.88 KB

README.md

File metadata and controls

101 lines (65 loc) · 2.88 KB
Raw

CampusFix

CampusFix is a real-time, end-to-end incident reporting and ticketing application designed for college campuses. It allows authenticated students to log infrastructure or facility incidents and enables authorized staff members to manage, track, and resolve them dynamically.

🚀 Features

  • Clean Slate Architecture: Completely wiped of historic mock data for a true 0-baseline production experience.
  • Dual-Database Support: Equipped with a seamless failover system leveraging both a local JSON database and remote MongoDB integration.
  • Dynamic Dashboard: Live front-end counters track active, pending, and resolved issues starting strictly from zero.
  • Real-time Alerts: Clear, reactive notification system to keep users updated on ticket status changes.

📂 Project Structure

├── src/
│   ├── db/
│   │   ├── db.js             # MongoDB connection and cleanup routines
│   │   ├── ticketModel.js    # Mongoose schema definitions
│   │   └── local_db.json     # Local fallback database registry (empty array)
│   ├── App.jsx               # Main dashboard UI component and state hooks
│   ├── data.js               # Initial ticket registries and static data voids
│   ├── main.jsx              # React DOM entry point
│   ├── index.css             # Application styling
│   └── utils.js              # Helper utilities
├── .env.example              # Sample environment variables
├── .gitignore                # Git untracked file configurations
├── index.html                # Application entry HTML
├── metadata.json             # Application metadata configuration
├── package.json              # Project dependencies and script definitions
├── server.js                 # Backend Node.js express server
└── vite.config.js            # Vite build tool configuration

🛠️ Prerequisites

Before running the application, ensure you have the following installed:

  • Node.js (v16 or higher)
  • MongoDB (Optional: for remote database state)

⚙️ Installation & Setup

  1. Clone the Repository (after downloading/pushing your code):
git clone <your-repository-url>
cd campusfix
  1. Install Dependencies:
npm install
  1. Configure Environment Variables: Duplicate the .env.example file and rename it to .env. Populated it with your MongoDB credentials:
MONGODB_URI=your_mongodb_connection_string
PORT=5000

🏃‍♂️ Running the Application

Development Mode

To spin up both the Vite frontend development server and the backend server:

npm run dev

Production Build

To compile the highly-efficient build paths and start the production application:

npm run build
npm start