Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dimaskiddo/codebase-go-rest-lite
Codebase for REST API in Go (Lite)
https://github.com/dimaskiddo/codebase-go-rest-lite
api codebase go golang lite rest server
Last synced: 7 days ago
JSON representation
Codebase for REST API in Go (Lite)
- Host: GitHub
- URL: https://github.com/dimaskiddo/codebase-go-rest-lite
- Owner: dimaskiddo
- Created: 2019-02-23T12:12:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-31T05:13:32.000Z (over 1 year ago)
- Last Synced: 2024-06-20T17:38:27.152Z (5 months ago)
- Topics: api, codebase, go, golang, lite, rest, server
- Language: Go
- Homepage:
- Size: 99.6 KB
- Stars: 6
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Codebase for REST API in Go (Lite)
This codebase help a new Go developer in developing a REST API using Go.
This codebase included with some pre bundle service or helper like authentication, logging, and predefined configuration. **This lite version does not have database, cache, or store driver**.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
See deployment for notes on how to deploy the project on a live system.
### Prerequisites
Prequisites package:
* Go (Go Programming Language)
* Dep (Go Dependencies Management Tool)
* Make (Automated Execution using Makefile)
Optional package:
* GoReleaser (Go Automated Binaries Build)
* Docker (Application Containerization)
### Installing
Below is the instructions to make this codebase running:
* Create a Go Workspace directory and export it as the extended GOPATH directory
```
cd
export GOPATH=$GOPATH:"`pwd`"
```
* Under the Go Workspace directory create a source directory
```
mkdir -p src///
```
* Move to the created directory and pull codebase
```
cd src///
git clone -b master https://github.com/dimaskiddo/codebase-go-rest-lite.git .
```
* Run following command to change the codebase repository URL to your own
```
make rebase REBASE_URL="//"
```
* Run following command to renew and pull dependecies package
```
make init
make vendor
```
* Until this step you already can run this code by using this command
```
make run
```
## Running The Tests
Currently the test is not ready yet :)
## Deployment
**Make sure your your go script does not relate to github.com/dimaskiddo/codebase-go-rest-lite anymore**.
To build this codebase to binaries for distribution purposes you can run following command:
```
make release
```
The build result will shown in build directory
## Built With
* [Go](https://golang.org/) - Go Programming Languange
* [Dep](https://github.com/golang/dep) - Go Dependency Management Tool
* [GoReleaser](https://github.com/goreleaser/goreleaser) - Go Automated Binaries Build
* [Make](https://www.gnu.org/software/make/) - GNU Make Automated Execution
* [Docker](https://www.docker.com/) - Application Containerization
## Authors
* **Dimas Restu Hidayanto** - *Initial Work* - [DimasKiddo](https://github.com/dimaskiddo)
See also the list of [contributors](https://github.com/dimaskiddo/codebase-go-rest-lite/contributors) who participated in this project
## Annotation
You can seek more information for the make command parameters in the [Makefile](https://raw.githubusercontent.com/dimaskiddo/codebase-go-rest-lite/master/Makefile)