Getting Started

This guide will help you set up and create your first Gorim application.

Prerequisites

Go 1.22.0 or higher
Basic understanding of Go programming
Familiarity with web development concepts

Quick Start

Install the CLI:

go install gorim.org/gorim-cli@latest

Create a new project:

gorim-cli startproject myproject
cd myproject
gorim-cli startapp user

This creates:

myproject/
├── api/          # API routes
├── settings/     # Configuration
├── migrations/   # Database migrations
├── user/         # Your new app
├── main.go
└── .env

Basic Setup

1. Database Setup

Gorim will use SQLite as default database.

You can change it to your preferred database by updating the database settings in myproject/settings/config.go.

func Configure() {
	// ...
	DATABASE = conf.Database{
		Name:     conf.GetEnv("DB_NAME", "sqlite.db"),
	}
}

2. Creating a Simple Model

Create a model in myproject/models/user.go:

package models

import "gorim.org/gorim/models"

type User struct {
	models.BaseModel // Optional: This will add id, created_at, updated_at, deleted_at fields
	Email		string		`validate:"required,email" json:"email"`
	Password	string		`validate:"required" json:"password"`
}

package migrations

func Register() []interface{} {
	return []interface{}{
		// Add your models here
		models.User{},
	}
}

3. Creating a Simple Serializer

Create a serializer in myproject/apps/user/serializers.go:

package user

import (
	"myproject/models"
	"gorim.org/gorim/serializers"
)

type UserSerializer struct {
	serializers.ModelSerializer[models.User]
	Email		string		`validate:"required,email" json:"email"`
	Password	string		`validate:"required" json:"password"`
}

4. Creating a Simple View

Create a view in myproject/apps/user/views.go:

package user

import (
    "gorim.org/gorim/views"
    "myproject/models"
)

type UserViewSet struct {
	views.ModelViewSet[models.User]
}

func NewUserViewSet() *UserViewSet {
	var serializer UserSerializer
	viewset := UserViewSet{}
	params := views.ModelViewSetParams[models.User]{
		Serializer: &serializer,
		Child: &viewset,
	}
	modelViewSet := views.NewModelViewSet(params)
	viewset.ModelViewSet = *modelViewSet
	return &viewset
}

5. Setting Up Routes

In your myproject/apps/user/router.go:

package user

import (
	"net/http"

	"gorim.org/gorim"
	"gorim.org/gorim/routers"
)

func RouterUser(group *gorim.Group) {
	routeGroup := group.Group("/users")
	routers.NewDefaultRouter[*UserViewSet](routeGroup, NewUserViewSet)
}

Add to myproject/api/routes.go:

package api

import (
	"myproject/api/user"
	"myproject/settings"
)

func APIRoutes() {
	api := settings.Server.Group("/api/v1")
	// Add your routes here
	user.RouterUser(api)
}

Running Your Application

Apply migrations (if any):

go run main.go migrate

Start the server:

go run main.go runserver

Your application will be available at http://localhost:8000.