https://github.com/cntm-labs/orbit-api
Personal finance management REST API
https://github.com/cntm-labs/orbit-api
backend java project-orbit spring-boot
Last synced: 3 months ago
JSON representation
Personal finance management REST API
- Host: GitHub
- URL: https://github.com/cntm-labs/orbit-api
- Owner: cntm-labs
- Created: 2026-03-14T11:48:52.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-03-17T11:41:49.000Z (4 months ago)
- Last Synced: 2026-03-18T01:28:30.196Z (4 months ago)
- Topics: backend, java, project-orbit, spring-boot
- Language: Java
- Homepage: https://mrbt-nano.github.io/orbit-api/
- Size: 1.37 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Orbit Personal Finance API
[](https://codecov.io/gh/cntm-labs/orbit-api)
Welcome to the **Orbit Personal Finance Management System**. This repository contains the core API (backend engine) responsible for managing financial ledgers, tracking multi-currency assets (including crypto), and orchestrating payments.
It is built to strict, top 1% engineering standards utilizing a Hexagonal "Package by Feature" Architecture.
---
## 📚 Interactive API Documentation
This project automatically generates and publishes its Swagger OpenAPI specification to a custom interactive Next.js website.
👉 **[View Live API Documentation](https://cntm-labs.github.io/orbit-api/)** *(Link active after first successful GitHub Action deployment)*
## 🚀 Quick Start (Local Development)
### Prerequisites
* Java 25
* Docker (for the local PostgreSQL database)
### Building & Running
Thanks to `spring-boot-docker-compose`, you do not need to manually configure a database. Running the app will automatically spin up the required PostgreSQL container.
```bash
# Clone the repository
git clone https://github.com/cntm-labs/orbit-api.git
cd orbit-api
# Run the application
./mvnw spring-boot:run
```
The API will be available at: `http://localhost:8080`
### Running Tests
To run the full test suite and automatically generate a local JaCoCo coverage report:
```bash
./mvnw clean test
```
## 📐 Architecture & Standards
This project adheres to elite coding standards. For detailed rules on how to write code, structure folders, and use AI agents within this repository, please read the following:
1. **[Architecture Specification](./architect/architecture-specification.md)** - Primary source of truth for all module contracts, conventions, and dependency rules.
2. **[GEMINI.md](./GEMINI.md)** - AI hooks and workspace context for Gemini.
3. **[CLAUDE.md](./CLAUDE.md)** - AI agent guidelines for Claude.
4. **[Clean Code Guidelines](./architect/clean_code_guidelines.md)** - Hexagonal Architecture, DTOs, and clean code principles.
## 🛡️ Security & CI/CD
Every Pull Request and commit to the `main` branch is subjected to a rigorous gauntlet of automated checks:
* **Spotless Formatting:** Code must comply with Google's Java Style Guide.
* **Unit Tests & Codecov:** Code coverage must not drop below 80%.
* **GitHub CodeQL:** Continuous scanning for security vulnerabilities (e.g., SQL Injection, XSS).
* **Dependabot:** Weekly automated dependency updates.
* **Documentation Verification:** A custom bash script (`scripts/verify-docs.sh`) ensures no API endpoint is merged without proper Swagger/OpenAPI documentation annotations.