https://github.com/lechitz/aionapi
Aion is a habit manager that organizes, tracks, and analyzes your routine to enhance your physical and mental well-being.
https://github.com/lechitz/aionapi
api architecture chi-router docker go golang gorm grafana graphql hexagonal jaeger open-telemetry ports-and-adapters prometheus redis rest-api unit-test zap
Last synced: about 1 month ago
JSON representation
Aion is a habit manager that organizes, tracks, and analyzes your routine to enhance your physical and mental well-being.
- Host: GitHub
- URL: https://github.com/lechitz/aionapi
- Owner: lechitz
- License: mit
- Created: 2024-11-09T20:07:30.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-25T19:09:56.000Z (about 1 month ago)
- Last Synced: 2025-08-25T20:45:52.464Z (about 1 month ago)
- Topics: api, architecture, chi-router, docker, go, golang, gorm, grafana, graphql, hexagonal, jaeger, open-telemetry, ports-and-adapters, prometheus, redis, rest-api, unit-test, zap
- Language: Go
- Homepage:
- Size: 1.18 MB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AionApi
_This repository is part of an ongoing study and development project. Many features are still being built and tested, so expect frequent changes as new tools and patterns are explored._
## Aion: Empowering you to take control of your time, habits, and aspirations
> _Aion is an innovative habit management system designed to help you organize, track, and analyze your daily routine for improved physical, mental, and emotional well-being. It combines cutting-edge technology with a user-centered approach to make your productivity and self-improvement journey seamless and insightful._
>
> Whether you’re focusing on fitness, learning, or personal growth, Aion is your companion in building the discipline you need to achieve sustainable success.
## **Table of Contents**
- [Overview](#overview)
- [Current and Upcoming Features](#current-and-upcoming-features)
- [Project Management](#project-management)
- [Installation](#installation)
- [Configuration](#configuration)
- [Development](#development)
- [API Endpoints](#api-endpoints)
- [REST Endpoints](#rest-endpoints)
- [GraphQL Operations](#graphql-operations)
- [License](#license)
---
## Overview
AionAPI is a backend service written in **Go** that exposes both REST and GraphQL endpoints. It relies on **PostgreSQL** for persistent storage and **Redis** for caching. The project follows the **Ports & Adapters (Hexagonal)** architecture, enabling clear separation between domain logic and external technologies. Observability is handled with **OpenTelemetry**, **Jaeger**, **Prometheus**, and **Grafana**, while structured logging is powered by **Zap**.
**Technology Stack**
- Go 1.24
- chi HTTP router and gqlgen for GraphQL
- GORM ORM for PostgreSQL
- Redis cache
- Docker & Docker Compose
- OpenTelemetry with Jaeger tracing and Prometheus metrics
- Grafana dashboards
- zap for structured logging
---
## Current and Upcoming Features
- **Streamlined Habit Management** — organize and track your habits effortlessly.
- **Data-Driven Insights** — visualize your progress and analyze behavior patterns.
- **Modern Integrations** — sync with tools and platforms for extended usability.
- **Developer-Friendly API** — clean, extensible endpoints for all your needs.
---
## Project Management
This repository is organized using a public [GitHub Projects board](https://github.com/users/lechitz/projects/1) where tasks, issues, and epics are tracked. The board provides visibility into ongoing work and completed milestones, keeping development structured and transparent.
---
## Installation
### Prerequisites
- [Go](https://go.dev/doc/install) 1.24 or newer
- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/) (for containerized development)
### Steps
1. **Clone the repository**
```bash
git clone https://github.com/lechitz/AionApi.git
cd AionApi
```
2. **Install development tools** (optional)
```bash
make tools-install
```
3. **Download Go dependencies**
```bash
go mod tidy
```
---
## Configuration
1. **Copy the example environment file**
```bash
cp infrastructure/docker/example/.env.example infrastructure/docker/dev/.env.dev
```
2. **Edit `.env.dev`** with values that match your local setup.
3. **Start the development environment**
```bash
make dev
```
4. **Run database migrations** (optional)
```bash
make migrate-up
```
---
## Development
The project is organized as follows:
```text
github/ - GitHub Actions workflows and issue templates
cmd/ - application entry point
infrastructure/ - migrations, docker files, observability configs
internal/ - domain logic, use cases, ports, and adapters
makefiles/ - grouped Make targets for builds, codegen, testing
pkg/ - shared utilities
tests/ - test data, mocks, and testing utilities
Dockerfile - Docker build instructions for the API
Makefile - main Makefile orchestrating tasks
.golangci.yml - static analysis and linter configuration
```
Run `make help` to see all available commands. Frequently used ones include:
```bash
make format # format Go code
make lint # run static analysis
make dev-up # start the development environment
make dev-down # stop and remove dev containers
make dev # builds and runs the dev environment
make verify # run full pipeline before committing
```
---
## API Endpoints
The API exposes REST endpoints for user management, authentication, and health checks, along with GraphQL operations for categories and tags.
### REST Endpoints
- `GET /aion-api/health-check/` — service status
- `POST /aion-api/user/create` — create a new user
- `GET /aion-api/user/all` — list users
- `GET /aion-api/user/{user_id}` — retrieve a user by ID
- `PUT /aion-api/user/` — update user data
- `PUT /aion-api/user/password` — update the logged user's password
- `DELETE /aion-api/user/` — soft delete the logged user
- `POST /aion-api/auth/login` — obtain a JWT token
- `POST /aion-api/auth/logout` — invalidate the user session
### GraphQL Operations
Endpoint: `/graphql`
- Queries: `GetAllCategories`, `GetCategoryByID`, `GetCategoryByName`, `GetAllTags`, `GetTagByID`
- Mutations: `CreateCategory`, `CreateTag`, `UpdateCategory`, `SoftDeleteCategory`
---
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.