uAdmin the Golang Web Framework

Easy to use, blazing fast and secure.

Originally open source by IntegrityNet Solutions and Services

For Documentation:

• Application in 2 Minutes!
• Coggle
• Read the Docs
• gophers.slack.com #uadmin

join gophers.slack.com

Social Media:

• Facebook
• Medium
• Twitter

Screenshots

Dashboard Menu

Log

Login Form

Features

• AB Testing System
• API Configuration
• Approval System
• Authentication and Permissions
• Clean and sharp UI
• Dashboard customization
• Data Access API (dAPI)
• Database schema migration
• Error Handling
• Export to Excel
• Form and List customization
• Image Cropping
• IP address and port configuration
• Log feature that keeps track of many things in your app
• Metric System
• Multilingual translation
• MySQL Database Support
• Offers FREE hosting for your app while you are developing by using a single command: uAdmin publish
• Pretty good security features (SSL, 2-Factor Authentication, Password Reset, Hash Salt, Database Encryption)
• Public access to media
• Self-relation of foreign key/many2many
• Sending an email from your app by establishing an email configuration
• System settings could be used system-wide to keep application settings
• Tag support for fields
• Translation files preloading
• Validation for user input
• Webcam support on image and file fields

Minimum requirements

• ^† A C compiler is required only if you plan to use cgo.
• ^‡ You only need to install the command line tools for Xcode. If you have already installed Xcode 4.3+, you can install it from the Components tab of the Downloads preferences panel.

Hardware

• RAM - minimum 256MB
• CPU - minimum 2GHz

Software

• Go Version 1.16 or later

Installation

go get -u github.com/rkj-tech/uadmin-with-postgres-ssl-options/
go install github.com/rkj-tech/uadmin-with-postgres-ssl-options/cmd/uadmin@latest

To test if your installation is fine, run the uadmin command line:

$ uadmin
Usage: uadmin COMMAND [--src]
This tools helps you prepare a folder for a new project or update static files and templates

Commands:
  prepare         Generates folders and prepares static and templates
  version         Shows the version of uAdmin

Arguments:
  --src           If you want to copy static files and templates from src folder

Get full documentation online:
https://uadmin-docs.readthedocs.io/en/latest/

Your First App

Let's build your first app which is a Todo list. First, we will create a folder for your project and prepare it.

$ mkdir -p ~/go/src/github.com/your_name/todo
$ cd ~/go/src/github.com/your_name/todo
$ uadmin prepare
[   OK   ]   Created: /Users/abdullah/go/src/github.com/twistedhardware/test/models
[   OK   ]   Created: /Users/abdullah/go/src/github.com/twistedhardware/test/api
[   OK   ]   Created: /Users/abdullah/go/src/github.com/twistedhardware/test/views
[   OK   ]   Created: /Users/abdullah/go/src/github.com/twistedhardware/test/media
[  INFO  ]   Copying static/templates from: /Users/abdullah/go/pkg/mod/github.com/rkj-tech/[email protected]
[   OK   ]   Created: /Users/abdullah/go/src/github.com/twistedhardware/test/static
[   OK   ]   Created: /Users/abdullah/go/src/github.com/twistedhardware/test/templates

Now use your code editor to create main.go and put this code inside it.

package main

import (
	"github.com/rkj-tech/uadmin-with-postgres-ssl-options"
	"time"
)

type Todo struct {
	uadmin.Model
	Name        string
	Description string `uadmin:"html"`
	TargetDate  time.Time
	Progress    int `uadmin:"progress_bar"`
}

func main() {
	uadmin.Register(Todo{})
	uadmin.StartServer()
}

Prepare modules

$ go mod init
go: creating new go.mod: module github.com/twistedhardware/test
go: to add module requirements and sums:
	go mod tidy

$ go mod tidy
go: finding module for package github.com/rkj-tech/uadmin-with-postgres-ssl-options
go: found github.com/rkj-tech/uadmin-with-postgres-ssl-options in github.com/rkj-tech/uadmin-with-postgres-ssl-options v0.6.0

Run your app (Linux, Apple macOS or Windows):

$ go build; ./todo
[   OK   ]   Initializing DB: [14/14]
[   OK   ]   Initializing Languages: [185/185]
[  INFO  ]   Auto generated admin user. Username:admin, Password:admin.
[   OK   ]   Synching System Settings: [49/49]
[   OK   ]   Server Started: http://0.0.0.0:8080
         ___       __          _
  __  __/   | ____/ /___ ___  (_)___
 / / / / /| |/ __  / __ '__ \/ / __ \
/ /_/ / ___ / /_/ / / / / / / / / / /
\__,_/_/  |_\__,_/_/ /_/ /_/_/_/ /_/

In Windows:

> go build && todo.exe
[   OK   ]   Initializing DB: [14/14]
[   OK   ]   Initializing Languages: [185/185]
[  INFO  ]   Auto generated admin user. Username:admin, Password:admin.
[   OK   ]   Synching System Settings: [49/49]
[   OK   ]   Server Started: http://0.0.0.0:8080
         ___       __          _
  __  __/   | ____/ /___ ___  (_)___
 / / / / /| |/ __  / __  __ \/ / __ \
/ /_/ / ___ / /_/ / / / / / / / / / /
\__,_/_/  |_\__,_/_/ /_/ /_/_/_/ /_/

Quick Reference

Overriding Save Function

func (m *Model) Save() {
	// business logic
	uadmin.Save(m)
}

Validation

func (m Model) Validate() (ret map[string]string) {
  ret = map[string]string{}
  if m.Name != "test" {
    ret["Name"] = "Error name not found"
  }
  return
}