https://github.com/danielost/blob-storage
https://github.com/danielost/blob-storage
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/danielost/blob-storage
- Owner: danielost
- Created: 2023-12-05T17:47:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-12T17:55:19.000Z (over 1 year ago)
- Last Synced: 2025-02-16T19:48:51.502Z (3 months ago)
- Language: Go
- Size: 214 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# blob-storage
## Description
[//]: # (TODO: add description)
## Install
```
git clone gitlab.com/dl7850949/blob-storage
cd blob-storage
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
```
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.
Note: if you are using Gitlab for building project `docs/spec/paths` folder must not be
empty, otherwise only `Build and Publish` job will be passed.
## Running from docker
Make sure that docker installed.
use `docker run ` with `-p 8080:80` to expose port 80 to 8080
```
docker build -t gitlab.com/dl7850949/blob-storage .
docker run -e KV_VIPER_FILE=/config.yaml gitlab.com/dl7850949/blob-storage
```
## 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/).
### Third-party services
## Contact
Responsible Danylo Ostapchenko
The primary contact for this project is t.me/danielosst