ERP Platform

A modern, modular ERP (Enterprise Resource Planning) platform built with Go + Fiber, Next.js, and GraphQL.

🏗️ Architecture

┌─────────────────────────────────────────────────────────────────┐
│                        ERP Platform                              │
├─────────────────────────────────────────────────────────────────┤
│  Frontend (Next.js)          │  Backend (Go + Fiber)            │
│  ├── React Components        │  ├── Core Platform               │
│  ├── Apollo Client           │  │   ├── Auth (JWT)              │
│  ├── Zustand State           │  │   ├── Database (PostgreSQL)   │
│  └── TailwindCSS            │  │   ├── Event Bus               │
│                              │  │   ├── Module Loader           │
│                              │  │   ├── Registry                │
│                              │  │   ├── RBAC Permissions        │
│                              │  │   └── Settings                │
│                              │  └── GraphQL API                 │
├──────────────────────────────┼──────────────────────────────────┤
│                         Modules                                  │
│  ├── Sales (Customers, Products, Orders, Invoices)              │
│  ├── Inventory (Coming Soon)                                     │
│  ├── Accounting (Coming Soon)                                    │
│  └── Custom Modules...                                           │
└─────────────────────────────────────────────────────────────────┘

✨ Features

Core Platform

• 🔐 Authentication: JWT-based auth with role support
• 👥 RBAC: Fine-grained role-based access control
• 🧩 Modular Architecture: Install, enable, disable, uninstall modules
• 📊 GraphQL API: Flexible, type-safe API
• 🔄 Event Bus: Inter-module communication
• ⚙️ Settings Management: Configurable per-module settings
• 📝 Audit Logging: Track all changes

Module System

• Module Discovery: Automatic discovery from /modules directory
• Dependency Management: Modules can depend on other modules
• Database Migrations: Per-module migration support
• Permission Registration: Modules register their own permissions
• Event Subscriptions: Subscribe to platform and other module events

🚀 Quick Start

Prerequisites

• Go 1.22+
• Node.js 20+
• PostgreSQL 15+
• Docker & Docker Compose (optional)

Using Docker Compose (Recommended)

# Clone the repository
git clone <repository-url>
cd erp-platform

# Copy environment file
cp .env.example .env

# Start all services
docker-compose up -d

# Access the application
# Frontend: http://localhost:3000
# Backend API: http://localhost:8080
# GraphQL Playground: http://localhost:8080/graphql

Manual Setup

Backend

cd backend

# Install dependencies
go mod download

# Copy and edit config
cp config/config.yaml.example config/config.yaml

# Run the server
make run

# Or with hot reload
make dev

Frontend

cd frontend

# Install dependencies
npm install

# Run development server
npm run dev

📁 Project Structure

erp-platform/
├── backend/
│   ├── cmd/
│   │   └── server/          # Application entry point
│   ├── core/
│   │   ├── auth/            # Authentication & JWT
│   │   ├── database/        # DB connection & migrations
│   │   ├── events/          # Event bus
│   │   ├── loader/          # Module loader
│   │   ├── logger/          # Structured logging
│   │   ├── permissions/     # RBAC system
│   │   ├── registry/        # Module registry
│   │   ├── settings/        # Settings storage
│   │   └── platform.go      # Main platform
│   ├── graph/               # GraphQL schema & resolvers
│   ├── modules/
│   │   └── sales/           # Example module
│   │       ├── module.json  # Module metadata
│   │       ├── migrations/  # SQL migrations
│   │       ├── models/      # Data models
│   │       ├── services/    # Business logic
│   │       └── module.go    # Module entry point
│   ├── config/
│   └── go.mod
├── frontend/
│   ├── src/
│   │   ├── app/             # Next.js App Router
│   │   ├── components/      # React components
│   │   ├── hooks/           # Custom hooks
│   │   └── lib/             # Utilities & GraphQL
│   ├── package.json
│   └── next.config.js
├── docker-compose.yml
└── README.md

🧩 Creating a Module

1. Create a new directory in backend/modules/<module-name>/

2. Create module.json:

{
  "id": "my-module",
  "name": "My Module",
  "version": "1.0.0",
  "description": "Description of my module",
  "author": "Your Name",
  "dependencies": [],
  "permissions": [
    "my-module.resource.view",
    "my-module.resource.create"
  ],
  "migrations": true
}

3. Create migrations in migrations/:

-- 001_create_tables.sql
CREATE TABLE my_module_items (
    id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
    name VARCHAR(255) NOT NULL,
    created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
);

4. Implement the module in module.go:

package mymodule

import (
    "context"
    "erp-platform/core/database"
    "erp-platform/core/events"
    "erp-platform/core/registry"
)

type Module struct {
    db       *database.Database
    eventBus *events.EventBus
}

func NewModule(db *database.Database, eventBus *events.EventBus) *Module {
    return &Module{db: db, eventBus: eventBus}
}

func (m *Module) GetMetadata() *registry.ModuleMetadata {
    // Load from module.json
}

func (m *Module) Initialize(ctx context.Context) error {
    // Subscribe to events, initialize services
    return nil
}

func (m *Module) Shutdown(ctx context.Context) error {
    // Cleanup
    return nil
}

🔧 API Reference

REST Endpoints

Method	Endpoint	Description
POST	/api/v1/auth/register	Register new user
POST	/api/v1/auth/login	Login
POST	/api/v1/auth/refresh	Refresh token
GET	/api/v1/modules	List modules
POST	/api/v1/modules/:id/enable	Enable module
POST	/api/v1/modules/:id/disable	Disable module

GraphQL

Access the GraphQL Playground at http://localhost:8080/graphql

Example queries:

# Login
mutation {
  login(input: { email: "[email protected]", password: "password" }) {
    accessToken
    user { id email }
  }
}

# Get modules
query {
  modules {
    id name version status
  }
}

🔐 Default Credentials

After initial setup, create an admin user:

curl -X POST http://localhost:8080/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","password":"admin123","first_name":"Admin","last_name":"User"}'

📝 License

MIT License - see LICENSE file for details.

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

---

Built with ❤️ using Go, Next.js, and PostgreSQL