This repository is the sample of web application using golang. This sample uses Echo as web application framework, Gorm as OR mapper and Zap logger as logger. This sample application provides only several functions as Web APIs. Please refer to the 'Service' section about the detail of those functions.

Also, this application contains the static contents such as html file, css file and javascript file which built vuejs-webapp-sample project to easily check the behavior of those functions. So, you can check this application without starting a web server for front end. Please refer to the 'Starting Server' section about checking the behavior of this application.

If you would like to develop a web application using golang, please feel free to use this sample.

Perform the following steps:

1. Download and install MinGW(gcc).
2. Download and install Visual Studio Code(VS Code).
3. Download and install Golang.
4. Get the source code of this repository by the following command.

   go get -u github.com/ybkuroki/go-webapp-sample

There are 2 methods for starting server.

1. Starting this web application by the following command.

   go run main.go

2. When startup is complete, the console shows the following message:

   http server started on [::]:8080
   

3. Access http://localhost:8080 in your browser.
4. Login with the following username and password.
   • username : test
   • password : test

1. Starting this web application by the following command.

   go run main.go

2. When startup is complete, the console shows the following message:

   http server started on [::]:8080
   

3. Access http://localhost:8080/api/health in your browser and confirm that this application has started.

   healthy
   

1. Clone vuejs-webapp-sample project and install some tools.
2. Start by the following command.

   npm run serve

3. When startup is complete, the console shows the following message:

   DONE Compiled successfully in *****ms
   
   App running at:
   - Local:   http://localhost:3000/
   - Network: http://192.168.***.***:3000/
   
   Note that the development build is not optimized.
   To create a production build, run npm run build.
   

4. Access http://localhost:3000 in your browser.
5. Login with the following username and password.
   • username : test
   • password : test

Build this source code by the following command.

go build main.go

The follwing figure is the map of this sample project.

- go-webapp-sample
    config                  … Define configurations of this system.
    logger                  … Provide loggers.
    middleware              … Define custom middleware.
    migration               … Provide database migration service for development.
    router                  … Define routing.
    controller              … Define controllers.
    model                   … Define models.
    repository              … Provide a service of database access.
    service                 … Provide a service of book management.
    session                 … Provide session management.
    test                    … for unit test
  - main.go                 … Entry Point.

This sample provides 3 services: book management, account management, and master management.

There are the following services in the book management.

There are the following services in the Account management.

There are the following services in the Master management.

This sample uses the following libraries.

Please read CONTRIBUTING.md for proposing new functions, reporting bugs and submitting pull requests before contributing to this repository.

The License of this sample is MIT License.