https://github.com/blankdots/minimalgo

Minimal go REST API project
https://github.com/blankdots/minimalgo

fiber-framework golang rest-api

Last synced: 4 days ago
JSON representation

Minimal go REST API project

• Host: GitHub
• URL: https://github.com/blankdots/minimalgo
• Owner: blankdots
• License: apache-2.0
• Created: 2020-06-09T11:39:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-01T05:45:25.000Z (8 months ago)
• Last Synced: 2024-04-01T06:47:02.226Z (8 months ago)
• Topics: fiber-framework, golang, rest-api
• Language: Go
• Homepage:
• Size: 3.83 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


## Minimal Golang Project

[![Go Report Card](https://goreportcard.com/badge/github.com/blankdots/minimalgo)](https://goreportcard.com/report/github.com/blankdots/minimalgo)

![Go Unit Tests](https://github.com/blankdots/minimalgo/workflows/Go/badge.svg)

![Go style check](https://github.com/blankdots/minimalgo/workflows/Multilinters/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/blankdots/minimalgo/badge.svg?branch=master)](https://coveralls.io/github/blankdots/minimalgo?branch=master)

An example of a minimal Golang project that contains an web application built with [fiber](https://github.com/gofiber/fiber).

At the same time the project exemplifies:

* fiber server;

* logging formatting;

* unit tests;

* github-actions and [coveralls](https://coveralls.io/github/blankdots/minimalgo) integration;

### Install and Run

Installation can be done:

* cloning repository:

```

$ git clone [email protected]:blankdots/minimalgo.git

$ cd minimalgo

$ pip install .

```

After install the application can be started like: `$ minimalgo`

#### Tests and Documentation

In order to run the tests: `$ go test -v ./...` in the root directory of the git project.

###  Structure

```

.

├── api

│   ├── api.go

│   └── health_test.go

├── coverage.txt

├── Dockerfile

├── go.mod

├── go.sum

├── LICENSE

├── main.go

├── minimalgo

├── README.md

└── utils

    └── utils.go

```

### License

`minimal` go and all it sources are released under `Apache License 2.0`.