Skip to content

README.md

Latest commit

 

History

History
225 lines (166 loc) · 9.89 KB

README.md

File metadata and controls

225 lines (166 loc) · 9.89 KB

SereniBase

Open-Source Self-Hosted Backend Platform — PostgreSQL + Auto REST APIs + JWT + Storage + ClamAV

A production-ready, self-hosted backend platform built on PostgreSQL. Every table you create automatically generates a documented REST API. JWT authentication, S3/MinIO file storage with ClamAV malware scanning, and SMTP email delivery run as independent microservices — deploy together with a single docker-compose up, or standalone as needed. Licensed under the Apache License 2.0. Full data sovereignty.

Go React PostgreSQL Gin Docker MinIO ClamAV Swagger

Github Actions CodeQL Go Report Quality Gate Coverage Security

License PRs Welcome Beta

🚀 Live Demo

SereniBase Demo

Live Demo

Try the live demo: https://demo.serenibase.com/login
See SereniBase in action with all features enabled.

Default login credentials

Field Value
Email admin@example.com
Password Admin@123
Live Demo (no install) https://demo.serenibase.com

⭐ If this project helps you, please consider giving it a star!
👉 https://github.com/aptlogica/sereni-base

🚀 What is SereniBase?

A backend operating system. Not another tool.

Instead of stitching together separate services, developers get a unified backend where database, APIs, auth, storage, email, and security are already designed to work together.

  • Create a table → get a REST API. Instantly. No code.
  • JWT auth, S3 storage, SMTP email, ClamAV scanning — all running as microservices.
  • Integrate seamlessly with your existing systems via REST API or TypeScript SDK.
  • Visual UI for teams + TypeScript SDK for developers.
  • Self-hosted or cloud-ready. Full data sovereignty. Zero vendor lock-in.

SereniBase Demo SereniBase Demo

🔥 Why SereniBase?

Most no-code tools work… until they don’t.

Problem SereniBase Solution
Vendor lock-in ✅ Self-hosted
Limited extensibility ✅ Open-source & modular
Expensive scaling ✅ Infrastructure-based cost
Privacy concerns ✅ Full data ownership
No built-in file security ✅ ClamAV antivirus scans every upload before storage
Separate email service needed ✅ SMTP microservice with Redis queue and retry — included
Assembling disconnected tools ✅ Database + API + Auth + Storage + Email + Security — one stack

⚡ Key Features

  • 🗄️ No-Code + Developer Friendly
  • 🔌 REST API (OpenAPI/Swagger)
  • 🧩 Microservices Architecture
  • 🏢 Multi-Tenant Workspaces
  • ⚡ Dynamic Schema (no migrations)
  • 🔐 Enterprise Security (RBAC, audit logs)

Services Architecture

Service Description Port
sereni-base Core REST API server 8080
PostgreSQL Primary database 5432
JWT Provider Authentication service 8081
Email Service SMTP email notifications 8082
Storage Provider File storage (MinIO/S3) 8083
Antivirus Service ClamAV malware scanning 8084
MinIO Object storage 9000/9001
Base UI Frontend application 5050

Quick Start

Prerequisites

Requirement Version Installation
Docker 20.10+ Install Docker
Docker Compose 2.0+ Install Compose
Git Latest Install Git
Make Latest Windows: choco install make
SMTP Access - Gmail, SendGrid, Mailgun, or custom SMTP

Installation

# Step 1: Clone the repository
git clone https://github.com/aptlogica/sereni-base.git
cd sereni-base

# Step 2: Run interactive setup wizard
make setup

# Alternative (without Make):
# Windows: .\setup-interactive.ps1
# Linux/macOS: ./setup-interactive.sh

The setup wizard will:

  • Prompt for configuration (press Enter for defaults)
  • Generate .env file
  • Start all services with Docker Compose

Access Points

Service URL
Frontend http://localhost:5050
Backend API http://localhost:8080
API Documentation http://localhost:8080/swagger/index.html
MinIO Console http://localhost:9001

Default Login

Default credentials are configured via environment variables. See .env.example for setup.

⚠️ Security: Never use default credentials in production. Always configure secure values via environment variables.

Commands Reference

Command Description
make setup Run interactive setup wizard
make setup-y Run setup with default values (non-interactive)
make up Start all services
make down Stop services (preserve data)
make down-all Stop services and remove volumes
make logs View service logs
make restart Restart all services
make ps Show running services
make status Show detailed service status
make clean Remove containers (preserve data)
make clean-all Full cleanup (containers + volumes + images)

Documentation

Document Description
Complete Setup Guide Comprehensive beginner guide
Setup Reference Quick reference setup guide
Interactive Setup Setup wizard documentation
Environment Variables Configuration reference

Security

See SECURITY.md for reporting vulnerabilities.

Contributing

We welcome contributions! See our contribution guidelines for details.

Ecosystem

SereniBase is the core of a full backend platform. All modules are open-source and can be used independently or together:

Module Purpose License
sereni-jwt-provider JWT auth microservice Apache 2.0
sereni-storage-provider S3/MinIO/local storage Apache 2.0
sereni-email-smtp SMTP email + Redis queue Apache 2.0
sereni-antivirus-clamav ClamAV file scanning Apache 2.0
go-postgres-rest PostgreSQL REST API lib Apache 2.0
base-sdk TypeScript SDK Apache 2.0
base-ui React frontend MIT

License

Licensed under the Apache License, Version 2.0. Copyright 2026-2030 Aptlogica Technologies Pvt Ltd.