https://github.com/dl-nft-books/network-svc

Service for managing networks and displaying their info
https://github.com/dl-nft-books/network-svc

backend blockchain golang json-api psql

Last synced: 13 days ago
JSON representation

Service for managing networks and displaying their info

• Host: GitHub
• URL: https://github.com/dl-nft-books/network-svc
• Owner: dl-nft-books
• License: apache-2.0
• Created: 2023-03-02T10:16:22.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-04-18T08:40:38.000Z (almost 2 years ago)
• Last Synced: 2024-11-19T22:53:08.632Z (3 months ago)
• Topics: backend, blockchain, golang, json-api, psql
• Language: Go
• Homepage:
• Size: 4.1 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

        
# Network-svc

## Description

Service for managing networks and displaying their info

## Install

  ```bash

  git clone network-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 network-svc .

docker run -e KV_VIPER_FILE=/config.yaml network-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`)