Skip to content

Matsomot/CarFleet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Car Fleet Manager

Self-hosted application for managing cars (fleet or personal collection). Provides a REST API to create, read, update, and delete cars. Containerized for easy deployment.

Features (initial)

  • Node.js + TypeScript + Express backend
  • Health check endpoint
  • Cars CRUD endpoints (in-memory store to start)
  • Dockerfile and docker-compose for self-hosting

Quick start (Docker)

  1. Copy environment file: cp .env.example .env
  2. Build and start the app: docker compose up -d --build
  3. API should be available at http://localhost:3000

API

  • GET /health
  • GET /api/cars
  • POST /api/cars
  • GET /api/cars/:id
  • PUT /api/cars/:id
  • DELETE /api/cars/:id

Request/response examples are documented inline in the code and will be expanded as the project evolves.

Local development (optional)

Requirements: Node.js 18+

  • Install dependencies: npm install
  • Start dev server (auto-reload): npm run dev

Roadmap

  • Persist data using a database (e.g., Postgres)
  • AuthN/AuthZ
  • Basic UI
  • Backups and observability

License

MIT

About

Car Management Open Source

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors