Documentation/Overview
Overview

Getting Started

Create a Gorix application, register modules, and run the development server.

Prerequisites

Install a supported Go toolchain and Git. Check your local versions:

go version
git --version

Create a project

1. Initialize the module

mkdir gorix-starter
cd gorix-starter
go mod init example.com/gorix-starter

2. Add Gorix

go get github.com/Gromosome/gorix/gorix@latest

3. Create the application entry point

package main

import "github.com/Gromosome/gorix/gorix"

func main() {
    app := gorix.New()

    app.RegisterModules(
        UserModule(),
    )

    app.Listen()
}

4. Run the service

go run .

Suggested project structure

gorix-starter/
├── main.go
├── go.mod
├── config/
│   └── application.yaml
└── internal/
    └── user/
        ├── user.controller.go
        ├── user.module.go
        └── user.service.go

Next steps

Continue with Core Concepts to understand how modules, controllers, and services work together.