scanner_backend_api

module
v0.0.0-...-880d6bc Latest Latest
Warning

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

Go to latest
Published: Jun 24, 2023 License: MIT

README

scanner_backend_api

Description

scanner_backend_api is a backend side of tg_scanner application

Documentation

Swagger docs included and hosted on github pages

Technology

Go, PostgreSQL, Gorilla-Mux, Zap, Go-Sqlmock, Testify, Golang-Migrate, JWT, Swagger

Installation

 git clone git@github.com:VladPetriv/scanner_backend_api.git

 cd scanner_backend_api

 go mod download

Before start

Please create .env file with this fields:

  • DATABASE_URL = PostgreSQL user
  • LOG_LEVEL = Level which logger will handle
  • MIGRATIONS_PATH = Path to migrations:file://./db/migrations
  • PORT = Bind address which server going to use
  • JWT_SECRET_KEY = Secret key for json web token

Usage

Start with docker-compose:

 make docker

Start an application locally:

 make run 

Running test suite:

 make mock # Run it if mocks folder is not exist

 make test

Directories

Path Synopsis
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
internal
pkg
lib

Jump to

Keyboard shortcuts

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