Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vladpetriv/scanner_backend_api
backend side represented as REST-API for processing data from tg_scanner
https://github.com/vladpetriv/scanner_backend_api
go jwt postgresql rest-api
Last synced: 10 days ago
JSON representation
backend side represented as REST-API for processing data from tg_scanner
- Host: GitHub
- URL: https://github.com/vladpetriv/scanner_backend_api
- Owner: VladPetriv
- License: mit
- Created: 2022-06-21T16:15:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-06T09:04:59.000Z (about 2 years ago)
- Last Synced: 2023-03-04T04:50:25.590Z (over 1 year ago)
- Topics: go, jwt, postgresql, rest-api
- Language: Go
- Homepage:
- Size: 2.33 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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
```bash
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:
```bash
make docker
```
Start an application locally:
```bash
make run
```
Running test suite:
```bash
make mock # Run it if mocks folder is not exist
make test
```