Aller au contenu

🏠 ContractPlattform WhiteLabel

Multi-Tenant Real Estate Contract Management Platform

πŸš€ Quick Start

# 1. Start Database
cd docker && docker-compose up -d

# 2. Install Dependencies
npm install

# 3. Setup Environment
cp .env.example .env

# 4. Start Development Server
npm run dev

Server lΓ€uft auf: http://localhost:3000

πŸ“Š Status

Component Status Description
Core Engine βœ… Ready Express + TypeScript
API Routes βœ… Ready REST API mit Cache
sevDesk βœ… Implemented Rechnungen, Kontakte
evcc βœ… Implemented Wallbox, LadevorgΓ€nge
Edge Cache βœ… Ready CF Workers / Memory
MS Graph 🟑 Skeleton OAuth noch nicht konfiguriert
ista πŸ”΄ TODO Nebenkostenabrechnung
plane.so πŸ”΄ TODO Projektmanagement
Link Description
API Overview REST API Dokumentation
Integrations Externe Systeme
Architecture System-Architektur
Konzept VollstΓ€ndiges Konzept

�️ Tech Stack

  • Runtime: Node.js 20+
  • Framework: Express.js
  • Language: TypeScript 5.x
  • Database: PostgreSQL + Prisma
  • Cache: In-Memory / Cloudflare KV
  • Testing: Vitest

πŸ“ Project Structure

src/
β”œβ”€β”€ main.ts              # Entry Point
β”œβ”€β”€ api/                 # REST Routes
β”‚   └── routes/
β”œβ”€β”€ core/                # Business Logic
β”‚   β”œβ”€β”€ services/
β”‚   β”œβ”€β”€ types/
β”‚   └── cache/
β”œβ”€β”€ integrations/        # External APIs
β”‚   β”œβ”€β”€ sevdesk.ts
β”‚   β”œβ”€β”€ evcc.ts
β”‚   └── msgraph.ts
└── middleware/          # Express Middleware

edge/                    # Cloudflare Workers
β”œβ”€β”€ worker.ts
└── wrangler.toml

tests/                   # Vitest Tests

πŸ§ͺ Testing

# Run all tests
npm test

# Run with coverage
npm test -- --coverage