https://github.com/flaiers/flallet
Wallet microservice
https://github.com/flaiers/flallet
docker docker-compose fiber go golang golangci-lint postgresql s3
Last synced: 3 months ago
JSON representation
Wallet microservice
- Host: GitHub
- URL: https://github.com/flaiers/flallet
- Owner: Flaiers
- License: apache-2.0
- Created: 2022-11-23T14:22:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-23T14:42:58.000Z (over 2 years ago)
- Last Synced: 2025-01-25T18:43:32.742Z (5 months ago)
- Topics: docker, docker-compose, fiber, go, golang, golangci-lint, postgresql, s3
- Language: Go
- Homepage:
- Size: 47.9 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Microservice for working with user balance
## Documentation
1. Postman: [docs/postman.json](docs/postman.json)
2. Swagger: [localhost:3000/api/v1/docs](http://localhost:3000/api/v1/docs)
---
## Requirements
1. Go 1.19+: [go.dev/dl](https://go.dev/dl)
2. Docker: [docs.docker.com/get-docker](https://docs.docker.com/get-docker)
3. Docker Compose: [docs.docker.com/compose/install](https://docs.docker.com/compose/install)
4. GolangCI: [golangci-lint.run/usage/install](https://golangci-lint.run/usage/install)
---
## Makefile
> Display all targets
```bash
make help
```
```
Usage:
make
help Display this help screen
install Installations
lint Run linters
swag Generate swagger docs
run Run application
migrate Migrate database
build Build application
compose-convert Converts the compose file to platform's canonical format
compose-build Build or rebuild services
compose-up Create and start containers
compose-down Stop and remove containers, networks
compose-logs View output from containers
compose-ps List containers
compose-ls List running compose projects
compose-exec Execute a command in a running container
compose-start Start services
compose-restart Restart services
compose-stop Stop services
docker-rm-volume Remove db volume
docker-clean Remove unused data
```
---
## Run microservice
> Installations
```bash
make install
```
> Up database
```bash
make compose-up services="db"
```
> Migrate database
```bash
make migrate
```
> Run application
```bash
make run
```
---
## Run microservice in Docker
> Create and start containers
```bash
make compose-up
```
---
## Environment variables
> Display all examples of variables
```bash
cat .env.example
```
```
# Backend
BACKEND_HOST = localhost
BACKEND_PORT = 3000
BACKEND_CORS_ORIGINS = http://localhost, https://localhost, https://localhost:8080, http://localhost:8080
# Database
DB_HOST = localhost
DB_PORT = 5432
DB_USER = postgres
DB_PASS = postgres
DB_NAME = db
# S3
S3_REGION = us-east-1
S3_BUCKET = flallet
S3_ENDPOINT = https://flaiers.s3.amazonaws.com
S3_ACCESS_KEY = ...
S3_SECRET_ACCESS_KEY = ...
```
---
## Environment variables in Docker
> Display all examples of variables
```bash
cat docker/.env.example
```
```
# Backend
BACKEND_HOST = 0.0.0.0
BACKEND_PORT = 3000
HOST_BACKEND_PORT = 3000
BACKEND_CORS_ORIGINS = http://localhost, https://localhost, https://localhost:8080, http://localhost:8080
# Database
DB_HOST = db
DB_PORT = 5432
HOST_DB_PORT = 5432
DB_USER = postgres
DB_PASS = postgres
DB_NAME = db
# S3
S3_REGION = us-east-1
S3_BUCKET = flallet
S3_ENDPOINT = https://flaiers.s3.amazonaws.com
S3_ACCESS_KEY = ...
S3_SECRET_ACCESS_KEY = ...
# Docker
COMPOSE_PROJECT_NAME = flallet
```