Skip to main content
Version: v0.7.1-beta

Project Structure

This section describes the directory structure of the main Ambrosia POS repository, a comprehensive system for restaurants and retail with Bitcoin integration.

ambrosia/
β”œβ”€β”€ .github/ # CI/CD Workflows (Linter, Tests, E2E)
β”œβ”€β”€ client/ # Next.js Frontend (React 19, Tailwind CSS)
β”‚ β”œβ”€β”€ __tests__/ # Client unit tests
β”‚ β”œβ”€β”€ public/ # Static assets (SVG, images)
β”‚ └── src/ # Frontend source code
β”‚ β”œβ”€β”€ app/ # Next.js App Router (pages and layouts)
β”‚ β”œβ”€β”€ components/ # Reusable React components
β”‚ β”œβ”€β”€ hooks/ # Custom React Hooks
β”‚ β”œβ”€β”€ i18n/ # Internationalization configuration
β”‚ β”œβ”€β”€ lib/ # Shared libraries and configurations
β”‚ β”œβ”€β”€ modules/ # App-specific modules
β”‚ └── services/ # Services for API calls
β”œβ”€β”€ doc/ # Additional documentation (installation, proposal)
β”œβ”€β”€ electron/ # Desktop wrapper for the application
β”‚ β”œβ”€β”€ scripts/ # Build scripts for different platforms
β”‚ β”œβ”€β”€ services/ # System-side logic (Backend, Phoenixd)
β”‚ └── utils/ # Health utilities and port management
β”œβ”€β”€ imgs/ # Visual assets and project icons
β”œβ”€β”€ scripts/ # Utility scripts (install, uninstall, run)
β”œβ”€β”€ server/ # Kotlin Backend (Ktor Framework)
β”‚ β”œβ”€β”€ app/ # Main server application
β”‚ β”‚ └── src/ # Source code (Kotlin/Java)
β”‚ β”œβ”€β”€ e2e_tests_py/ # End-to-End tests in Python (Pytest)
β”‚ └── gradle/ # Gradle Wrapper configuration
β”œβ”€β”€ docker-compose.yml # Service orchestration (Server, Client, Phoenixd)
β”œβ”€β”€ Makefile # Task automation for build and execution
└── README.md # Main project documentation
Main Repository

You can find the full source code in our official GitHub repository.