# 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 [email protected]: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