uAdmin

The web framework for Golang

Programming language: Go

License: MIT License

Tags: Web Frameworks    

Latest version: v0.5.2

README

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 which can 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

Operating System	Architectures	Notes
FreeBSD 10.3 or later	amd64, 386	Debian GNU/kFreeBSD not supported
Linux 2.6.23 or later with glibc	amd64, 386, arm, arm64, s390x, ppc64le	CentOS/RHEL 5.x not supported. Install from source for other libc.
macOS 10.10 or later	amd64	Use the clang or gcc† that comes with Xcode‡ for cgo support.
Windows 7, Server 2008 R2 or later	amd64, 386	Use MinGW gcc†. No need for cygwin or msys.

• † 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.10 or later

Installation

$ go get -u github.com/uadmin/uadmin/...

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

$ uadmin
Usage: uadmin COMMAND [-e email] [-d domain]
This tools allows you to publish your project online

Commands:
  publish         This publishes your project online
  prepare         Generates folders and prepares static and templates
  version         Shows the version of uAdmin

Arguments:
  -e, --email     Your email. This is required for you to be able to maintain your project.
  -d, --domain    You can choose your domain name which will customize your URL

Get full documentation online:
https://uadmin.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: /home/abdullah/go/src/github.com/your_name/todo/models
[   OK   ]   Created: /home/abdullah/go/src/github.com/your_name/todo/api
[   OK   ]   Created: /home/abdullah/go/src/github.com/your_name/todo/views
[   OK   ]   Created: /home/abdullah/go/src/github.com/your_name/todo/media
[   OK   ]   Created: /home/abdullah/go/src/github.com/your_name/todo/static
[   OK   ]   Created: /home/abdullah/go/src/github.com/your_name/todo/templates

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

package main

import (
    "github.com/uadmin/uadmin"
    "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()
}

Now to run your code (Linux and Apple macOS):

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

In Windows:

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

Publish your app

To take your app live, it is simple:

$ uadmin publish
Enter your email: [email protected]
Your project will be published to https://my-proj.uadmin.io
Enter the name of your sub-domain (my-proj) [auto]: my-app
Did you change the default port from 8080?
This is the port you have in uadmin.Port = 8080
Enter the port that your server runs on [8080]:
[   OK   ]   Compressing [420/420]
[   OK   ]   Your application has been uploaded
[   OK   ]   Application installed succesfully
[   OK   ]   Your Project has been published to https://my-app.uadmin.io/

Quick Reference

Overriding Save Function

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

Validation

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