Nucleus

🚀 Schema-driven framework for building powerful, flexible, and easy-to-use REST APIs and GraphQL with Go

schemas/user.yaml

module:
    name: user
    displayName: User Management

    models:
    - name: User
        displayName: User
        timestamps: true
        softDelete: true
        fields:
        - name: email
            type: email
            required: true
            unique: true
            validation:
            email: true
            api:
            expose: true
            searchable: true

Powerful Features

Everything you need to build modern APIs with confidence and speed

Schema-Driven Development

Define models and APIs from YAML schemas. Generate complete CRUD operations automatically with full validation and type safety.

Multi-Database Support

PostgreSQL, MySQL, MongoDB, SQL Server, SQLite - switch between databases without changing a single line of code.

REST & GraphQL

Support both REST and GraphQL protocols with consistent response formats and automatic schema generation.

File Upload Support

Native multipart/form-data support without base64 encoding. Built-in validation and CDN integration.

Internationalization (i18n)

Automatic translation system with placeholder support. Auto-generate translation files with safe JSON escaping.

Authentication & Authorization

JWT-based authentication with role-based permissions. Configurable middleware and secure token handling.

Universal Database Support

One framework, any database. Switch between databases without changing your code.

PostgreSQL

Advanced SQL

MySQL

Popular SQL

MongoDB

NoSQL

SQL Server

Enterprise SQL

SQLite

Lightweight

.env

# Switch between databases without code changes
    DB_TYPE=postgres    # PostgreSQL
    DB_TYPE=mysql       # MySQL
    DB_TYPE=mongodb     # MongoDB
    DB_TYPE=sqlserver   # SQL Server
    DB_TYPE=sqlite      # SQLite

Get Started in Minutes

From zero to production-ready API in just a few commands

Clone & Setup

Get the framework and set up your development environment in seconds.

Define Schema

Create YAML schemas with fields, validation, and API configuration.

Generate Code

Auto-generate models, controllers, services, and repositories from your schema.

Run & Deploy

Start your API server and deploy with Docker. Your API is ready!

Terminal

# 1. Clone and setup
    git clone https://github.com/geektech-id/nucleus.git
    cd nucleus
    make dev-setup

    # 2. Create schema
    cp .env.example .env
    nano schemas/user.yaml

    # 3. Generate code
    make generate SCHEMA=schemas/user.yaml

    # 4. Run application
    make run

    # ✅ Your API is ready at localhost:8080!