Document System Tutorial Part 1 - Build A Project

In this part, we will cover on building and preparing a project from scratch.

First of all, let’s create a folder for your project and prepare it.

$ mkdir -p ~/go/src/github.com/your_name/document_system
$ cd ~/go/src/github.com/your_name/document_system
$ uadmin prepare
[   OK   ]   Created: /home/pc_name/go/src/github.com/your_name/document_system/models
[   OK   ]   Created: /home/pc_name/go/src/github.com/your_name/document_system/api
[   OK   ]   Created: /home/pc_name/go/src/github.com/your_name/document_system/views
[   OK   ]   Created: /home/pc_name/go/src/github.com/your_name/document_system/media
[   OK   ]   Created: /home/pc_name/go/src/github.com/your_name/document_system/static
[   OK   ]   Created: /home/pc_name/go/src/github.com/your_name/document_system/templates

Use your favorite editor to create “main.go” inside that path. Put the following code in “main.go”.

package main

import (
    "github.com/uadmin/uadmin"
)

func main() {
    // Assign Site Name value as "Document System"
    // NOTE: This code works only if database does not exist yet.
    uadmin.SiteName = "Document System"

    // Activates a uAdmin server
    uadmin.StartServer()
}

Important

In Windows, you need to use localhost in order to run your application (e.g. http://localhost:8080). Another way is to set your loopback Internet protocol (IP) address by using uadmin.BindIP to establish an IP connection to the same machine or computer being used by the end-user.

Sample:

func main(){
    // Assign BindIP value to "127.0.0.1" in the Settings
    // NOTE: This code works only if database does not exist yet.
    uadmin.BindIP = "127.0.0.1"
}

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

go build; ./document_system

In Windows:

go build & document_system

Result:

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

Open your browser and type the IP address above. Then login using “admin” as username and password.

You will be greeted by the Document System dashboard that contains the system models built in uAdmin.

Click here to view our progress so far.

In the next part, we will discuss about creating and registering an external models in our application.

• Document System Tutorial Part 1 - Build A Project (Current Progress)