🚗 Inspecto – Your Trusted Vehicle Inspection Platform

Inspecto connects vehicle owners with certified inspectors, offering a seamless, reliable, and transparent inspection experience. Whether buying, maintaining, or needing reports for a vehicle, Inspecto simplifies your workflow.

Table of Contents

• Features
• Tech Stack
• Screenshots
• Getting Started
• Project Structure
• Environment Variables
• Security
• Folder Structure
• Contributing
• Contact
• Roadmap
• License

Features

For Users

• Secure Registration & Login
• Vehicle Management: add, edit, and delete vehicles
• Book Inspections with certified professionals
• Access, Download & Share Reports
• Direct Messaging with Inspectors

For Inspectors

• Verification Workflow & Onboarding
• Manage Inspection Requests
• Upload Inspection Reports
• Grow Your Customer Base

For Admins

• Manage Users & Inspectors
• Monitor Inspections & Reports
• Analytics Dashboard

Tech Stack

• Frontend: React.js (Vite), Tailwind CSS, Redux Toolkit, Axios
• Backend: Node.js, Express.js, MongoDB, Socket.io (real-time), JWT authentication
• File Storage: Cloudinary

Screenshots

Screenshot 1	Screenshot 2

Screenshot 3	Screenshot 4

Screenshot 5	Screenshot 6

Getting Started

Prerequisites

• Node.js (v18+ recommended)
• npm or yarn
• MongoDB instance (local or cloud)

Clone & Install

git clone https://github.com/square-story/Inspecto.git
cd Inspecto

Backend

cd backend
npm install
cp .env.example .env # Configure your .env variables
npm run dev:backend

Frontend

cd frontend
npm install
cp .env.example .env # Configure your .env variables
npm run dev

Test Setup

Manual and automated test instructions go here.

Project Structure

Inspecto/
  backend/
    src/
      ...
  frontend/
    src/
      ...
  docker-compose.yml
  README.md

Environment Variables

See .env.example files in both backend and frontend folders for configuration variables including database URIs, Cloudinary keys, and JWT secrets.

Security

• Role-based access (Admin, Inspector, User)
• Secure file uploads and cloud storage
• JWT-based authentication
• Input validation

Folder Structure

Inspecto/
│
├── .github/
│   └── workflows/
│       └── deploy-backend-render.yml
│
├── backend/
│   ├── .gitignore
│   ├── Dockerfile
│   ├── eslint.config.mjs
│   ├── jest.config.ts
│   ├── package-lock.json
│   ├── package.json
│   ├── tsconfig.json
│   └── src/
│       ├── __tests__/
│       ├── config/
│       ├── controllers/
│       ├── core/
│       ├── di/
│       ├── dtos/
│       ├── middlewares/
│       ├── models/
│       ├── repositories/
│       ├── routes/
│       ├── scripts/
│       ├── services/
│       ├── utils/
│       ├── app.ts
│       └── server.ts
│
├── frontend/
│   ├── .gitignore
│   ├── Dockerfile
│   ├── components.json
│   ├── eslint.config.js
│   ├── index.html
│   ├── package-lock.json
│   ├── package.json
│   ├── postcss.config.js
│   ├── tailwind.config.js
│   ├── tsconfig.app.json
│   ├── tsconfig.json
│   ├── tsconfig.node.json
│   ├── vercel.json
│   ├── vite.config.ts
│   ├── public/
│   │   └── favicon.ico
│   └── src/
│       ├── api/
│       ├── app/
│       ├── components/
│       ├── contexts/
│       ├── features/
│       ├── helper/
│       ├── hooks/
│       ├── lib/
│       ├── pages/
│       ├── provider/
│       ├── routes/
│       ├── services/
│       ├── store/
│       ├── types/
│       ├── utils/
│       ├── App.tsx
│       ├── index.css
│       ├── main.tsx
│       └── vite-env.d.ts
│
├── .gitignore
├── README.md
├── docker-compose.yml
├── package-lock.json
└── package.json

Contributing

We love contributions! Please read CONTRIBUTING.md if available, otherwise:

1. Fork this repository
2. Create a feature branch (git checkout -b feature/myFeature)
3. Commit your changes (git commit -m "Add my feature")
4. Push to the branch (git push origin feature/myFeature)
5. Open a pull request with a clear description

Contact

• Open an issue on GitHub for bug reports or feature requests
• Email: sadik.build@gmail.com
• Demo: inspecto-flax.vercel.app

Roadmap

• GPS-based real-time inspector tracking
• Advanced analytics for admins
• Dedicated Android/iOS mobile app

License

MIT License (if applicable, clarify or add license file)