https://github.com/smf8/gokkan

Gokkan is a dokkan (shop) backend written in Go
https://github.com/smf8/gokkan

echo echo-server ecommerce go golang jwt-authentication rest-api restful-api shop

Last synced: about 1 month ago
JSON representation

Gokkan is a dokkan (shop) backend written in Go

• Host: GitHub
• URL: https://github.com/smf8/gokkan
• Owner: smf8
• Created: 2021-07-12T04:04:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T09:15:47.000Z (almost 2 years ago)
• Last Synced: 2024-04-24T12:57:52.127Z (8 months ago)
• Topics: echo, echo-server, ecommerce, go, golang, jwt-authentication, rest-api, restful-api, shop
• Language: Go
• Homepage:
• Size: 123 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Build Status](https://github.com/smf8/gokkan/actions/workflows/main.yml/badge.svg)

# Gokkan

Gokkan is an online shop backend service written in Go.

## Setup

### Requirements

```shell

# or docker-compose up

make up

```

Gokkan requires `postgresql` as database.

You can use `docker-compose` to get an instance up and running.

**Note the default settings in `internal/app/gokkan/config/default.go`

when connecting to the database.**

A `pgAdmin` instance is also inside docker-compsoe. you can use `localhost:8000` to check database with `pgAdmin`

### Install

Clone the repository inside a folder **outside** of GOPATH

```shell

git clone https://github.com/smf8/gokkan

cd gokkan

make build

# important before running the application

# please make sure that postgres is up and running

# before running migrates

make migrate-up

```

aAfter that you can use `gokkan` binary to run the server.

Use `gokkan -h` to see available commands. currently available commands are:

```shell

  ./gokkan server      # start the server

```

To clear database after tests run 

```shell

make migrate-reset

```

## Usage

Echo server will start listening on port `8080` by default.

A [Postman Collection file](gokkan_api.json) is provided to describe API behaviour