Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dl-nft-books/book-svc
Service for storing books information with basic CRUD operations on the API
https://github.com/dl-nft-books/book-svc
backend golang json-api psql
Last synced: about 2 months ago
JSON representation
Service for storing books information with basic CRUD operations on the API
- Host: GitHub
- URL: https://github.com/dl-nft-books/book-svc
- Owner: dl-nft-books
- License: apache-2.0
- Created: 2023-03-02T09:55:23.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-24T08:10:04.000Z (over 1 year ago)
- Last Synced: 2024-10-18T12:49:23.059Z (2 months ago)
- Topics: backend, golang, json-api, psql
- Language: Go
- Homepage:
- Size: 5.99 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# book-svc
## Description
Service for storing books information with basic CRUD operations on the API.
Book creating flow
To create a book, the frontend side gets a signed EIP712 create message from the backend when sending a POST method. Simultaneously, a “raw” book (with basic information) is being added to the database. Then `update_listener` on the tracker service will update mocked fields when the contract is deployed. To link the contract with our raw book, we use `token_id` field.
## Install
```bash
git clone book-svc
cd
go build main.go
export KV_VIPER_FILE=./config.yaml
./main migrate up
./main run service
```
## Documentation
We do use openapi:json standard for API. We use swagger for documenting our API.
To open online documentation, go to [swagger editor](http://localhost:8080/swagger-editor/) here is how you can start it
```bash
cd docs
npm install
npm start
```
To build documentation use `npm run build` command,
that will create open-api documentation in `web_deploy` folder.
To generate resources for Go models run `./generate.sh` script in root folder.
use `./generate.sh --help` to see all available options.
## Running from docker
Make sure that the docker is installed.
Use `docker run ` with `-p 8080:80` to expose port 80 to 8080
```bash
docker build -t book-svc .
docker run -e KV_VIPER_FILE=/config.yaml book-svc
```
## Running from Source
* Set up environment value with config file path `KV_VIPER_FILE=./config.yaml`
* Provide valid config file
* Launch the service with `migrate up` command to create database schema
* Launch the service with `run service` command
### Database
For services, we do use ***PostgresSQL*** database.
You can [install it locally](https://www.postgresql.org/download/) or use [docker image](https://hub.docker.com/_/postgres/).
## Contacts
Anastasiia Lishchenko is responsible for this service. Can be contacted via the _Telegram_ (`@Anastasiia_Lishchenko`)