FleetMind

FleetMind helps teams monitor fleet risk, detect anomalies, and simulate scenarios.

Table of Contents

• Features
• Getting Started
• Usage
• Configuration
• Project Structure
• Testing
• Contributing
• License
• Contact

Features

• Live view of risky vehicles and recent anomalies.
• Scenario simulation to test operational responses.
• Copilot-style query workflow for quick fleet insights.

Getting Started

Prerequisites

• Docker and Docker Compose
• A GROQ_API_KEY for copilot responses (other provider will be supported in future versions)

Installation

# Clone the repository
git clone https://github.com/M1ndSmith/fleetMind.git
cd fleetMind

# Set your API key
export GROQ_API_KEY="gsk_..."

# Start services
docker compose -f infra/docker-compose.yml up --build

Open the app at http://localhost:3000.

Demo Video

Watch the demo

Usage

Basic flow

1. Open the dashboard.
2. Review risky vehicles and anomalies.
3. Run a simulation for a selected vehicle.
4. Ask copilot for a short operational summary.

API smoke checks

curl http://localhost:8000/livez
curl http://localhost:8100/livez
curl http://localhost:8000/vehicles/risky
curl http://localhost:8000/anomalies

Copilot smoke check

curl -X POST http://localhost:8100/chat \
  -H "Content-Type: application/json" \
  -d '{"query":"Show me the top risky vehicles","session_id":"readme"}'

Configuration

Common runtime values:

• GROQ_API_KEY: enables LLM-backed copilot responses.
• NEXT_PUBLIC_API_TOKEN: frontend token for simulation calls.
• BACKEND_INTERNAL_URL: internal backend URL used by server-side frontend requests.
• COPILOT_INTERNAL_URL: internal copilot URL used by server-side frontend requests.
• API_TOKEN: backend token required for protected simulation endpoint.
• CORS_ORIGINS / cors_origins: allowed frontend origins for API access.

For local Docker usage, defaults are already provided in compose.

Project Structure

fleetMind/
├── backend/            # API, simulation, risk logic
├── copilot/            # chat/call orchestration over backend data
├── frontend/           # web UI
├── infra/              # docker compose and environment wiring
├── README.md
└── QUICKSTART.md

Testing

Backend

cd backend
./run_tests.sh -q --cov=app --cov-report=term-missing --cov-report=xml

Copilot

cd copilot
./run_tests.sh -q --cov=app --cov-report=term-missing --cov-report=xml

Frontend

cd frontend
npm ci
npm test
npm run test:coverage

Contributing

1. Fork the repository.
2. Create a feature branch.
3. Add tests for your changes.
4. Open a pull request with a clear summary and test notes.

License

MIT License.

Contact

For questions or collaboration, open an issue in this repository: https://github.com/M1ndSmith/fleetMind/issues