comment-api-go

command module
v0.0.0-...-1580491 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 19, 2020 License: MIT Imports: 8 Imported by: 0

README

Installation

Clone the git repository with this command. Make sure you already installed GIT on your computer.

git clone https://github.com/ibrahimakbar31/comment-api-go

Create and setup config.json file

Create config.json by copying template filename config-example.json located on root folder. config.json file must be saved at root folder. You might change the config.json filename by updating ENV GOCONFIGFILENAME on Dockerfile if necessary.

Fill up each parameters. DB1 is main DB which used postgresql database.

config.json file have 4 environments: development, test, staging and production.

If GOCUSTOMENV environment is not set up on your computer, then it will run development environment as default environment

you might set "Migration": true if you wanna build database table for the first time. And set to "Migration": false when table already created.

Default application port is 8000

Testing

From root folder, go to router folder

cd router

and run this command to run testing

go test -v

Docker

Make sure you already installed Docker on your computer.

You might setup docker image on Dockerfile if necessary. you might change your environment on GOCUSTOMENV parameter. Default Docker port is 8000.

run this command to create docker image

docker build -t comment-api-go .

From above command we created docker image with name: comment-api-go.

run this command to mount docker image

docker run -p 8000:8000 -it comment-api-go

API Documentation

API documentation can be found on: https://documenter.getpostman.com/view/3373119/T1DjkfTV

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
controller
v1
core
service

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL