nebularcore

README

NebularCore

Project name "Suggesting a vast, foundational core like a nebula, symbolizing the birthplace of new projects."

NebularCore is a modular Go backend framework created with inspiration from PocketBase. It provides a robust foundation for building scalable backend services with features like authentication, health monitoring, database migrations, and more.

Features

• 🔐 Authentication with JWT, OTP, and social providers
• 🏥 Health monitoring and system status
• 📦 Database support for PostgreSQL and SQLite
• 🔄 Flexible migration system
• 🛠️ Modular architecture
• 🌐 Built on Gin web framework

Quick Start

package main

import (
    "log"

    "github.com/volvlabs/nebularcore/core"
    "github.com/volvlabs/nebularcore/modules/auth"
    "github.com/volvlabs/nebularcore/modules/health"
)

func main() {
    // Initialize app with config
    app, err := core.NewApp("config.yml")
    if err != nil {
        log.Fatal(err)
    }

    // Register modules
    app.RegisterModule(auth.NewModule())
    app.RegisterModule(health.NewModule())

    // Start the server
    if err := app.Start(); err != nil {
        log.Fatal(err)
    }
}

Configuration

# config.yml
core:
  environment: development
  database:
    driver: postgres
    host: localhost
    username: postgres
    password: password
    name: nebularcore
    port: "5432"
    sslmode: disable
  server:
    port: "8888"
    host: localhost

modules:
    moduleA:
        ...
    moduleB:
        ...

Documentation

• Migrations Guide
• Module System
• Authentication
• Examples

License

(c) Volvlabs 2023 - 2024

Documentation

Index

• type NebularCore
  • func New[T config.Settings](options core.Options[T]) *NebularCore[T]
  • func (n *NebularCore[T]) Execute(ctx context.Context) error
  • func (n *NebularCore[T]) Start(ctx context.Context) error

Types

type NebularCore

type NebularCore[T config.Settings] struct {
	RootCmd *cobra.Command
	// contains filtered or unexported fields
}

func New

func New[T config.Settings](options core.Options[T]) *NebularCore[T]

func (*NebularCore[T]) Execute

func (n *NebularCore[T]) Execute(ctx context.Context) error

func (*NebularCore[T]) Start

func (n *NebularCore[T]) Start(ctx context.Context) error