Modern Point-of-Sale System for Bars & Restaurants
# Clone and setup
git clone https://github.com/Ardigi/HOST.git
cd host
# Quick setup (Windows PowerShell)
.\scripts\dev-setup.ps1
# Or manual setup
npm install
cp .env.example .env.local
npm run db:migrate
npm run dev
Quick Links:
HOST is a modern, fast, and user-friendly Point-of-Sale system designed specifically for bars and restaurants. Built with cutting-edge technologies and a focus on performance, accessibility, and developer experience.
Coming soon - UI screenshots will be added as components are completed
π Full tech stack details: TECH_STACK_2025.md
Windows (PowerShell):
.\scripts\dev-setup.ps1
macOS/Linux:
# Coming soon: ./scripts/dev-setup.sh
# 1. Clone repository
git clone https://github.com/Ardigi/HOST.git
cd host
# 2. Install dependencies
npm install
# 3. Configure environment
cp .env.example .env.local
cp apps/pos/.env.example apps/pos/.env.local
cp packages/database/.env.example packages/database/.env.local
# Edit .env.local files with your configuration
# 4. Setup database
npm run db:migrate
npm run db:seed
# 5. Start development server
npm run dev:pos
π Detailed setup guide: development-setup.md
host/
βββ apps/ # Applications
β βββ pos/ # Main POS SvelteKit app
β βββ kds/ # Kitchen Display System
β βββ admin/ # Admin dashboard
βββ packages/ # Shared packages
β βββ shared/ # Business logic
β βββ auth/ # Keycloak integration
β βββ database/ # Drizzle schema & migrations
β βββ ui/ # Svelte components
β βββ types/ # TypeScript types
βββ test/ # Test utilities
β βββ factories/ # Test data factories
β βββ fixtures/ # Test fixtures
βββ docs/ # Documentation
βββ scripts/ # Build & dev scripts
βββ e2e/ # E2E tests
# Development
npm run dev # Start all apps
npm run dev:pos # Start POS only
npm run dev:kds # Start KDS only
npm run dev:admin # Start admin only
# Testing
npm test # Run all tests
npm run test:watch # Watch mode
npm run test:coverage # Coverage report
npm run test:e2e # Playwright E2E tests
# Database
npm run db:migrate # Run migrations
npm run db:seed # Seed data
npm run db:studio # Drizzle Studio GUI
npm run db:reset # Reset database
# Code Quality
npm run lint # Check code
npm run lint:fix # Fix issues
npm run typecheck # Type check
npm run format # Format code
npm run check:all # Lint + typecheck + test
# Build
npm run build # Build all apps
npm run build:fresh # Clean build
npm run clean # Clean all
feature/POS-###-description
π Full workflow: CONTRIBUTING.md
We follow a rigorous Test-Driven Development approach with the testing pyramid:
/\
/ \ E2E Tests (5%)
/____\ - Critical user journeys
/ \
/ \ Integration Tests (25%)
/__________\ - API endpoints, DB operations
/ \
/______________\ Unit Tests (70%)
- Business logic, components
Component | Minimum | Target |
---|---|---|
Auth/Payments/Orders | 85% | 95% |
Database/API | 85% | 90% |
Business Logic | 80% | 85% |
UI Components | 80% | 85% |
# Unit tests
npm run test:unit
# Integration tests
npm run test:integration
# E2E tests
npm run test:e2e
# Coverage report
npm run test:coverage
# Watch mode
npm run test:watch
π Full testing guide: test-strategy.md
We welcome contributions! Please follow our TDD workflow and coding standards.
Read:
Setup: Run .\scripts\dev-setup.ps1
Pick an Issue: Check GitHub Issues
Write Tests First: TDD approach required
Submit PR: Use the PR template
Status: π’ Active Development Health: π’ Healthy Test Coverage: 701 passing tests (99.93% statements)
Implemented Features:
π Detailed progress: PROGRESS.md
Use our issue templates:
Proprietary Software
Copyright Β© 2025 Digi. All rights reserved.
Built with modern technologies:
πΊοΈ Detailed roadmap: 02-technical-roadmap.md
Building the future of hospitality technology