Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matbarofex/mtz-crypto
Servicio de ejemplo para capacitación en Go
https://github.com/matbarofex/mtz-crypto
gin go golang gorm
Last synced: 27 days ago
JSON representation
Servicio de ejemplo para capacitación en Go
- Host: GitHub
- URL: https://github.com/matbarofex/mtz-crypto
- Owner: matbarofex
- License: mit
- Created: 2021-09-23T18:54:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-05T11:02:33.000Z (about 3 years ago)
- Last Synced: 2024-06-21T18:25:00.659Z (6 months ago)
- Topics: gin, go, golang, gorm
- Language: Go
- Homepage:
- Size: 900 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mtz-crypto
Servicio de ejemplo para capacitación Go
## Descripción
Esta aplicación consulta periódicamente el precio de criptoactivos a una API
externa, y calcula el valor total de una billetera crypto en cada request.
La composición de las billeteras se almacena en PostgreSQL.
La aplicación está diseñada para ser desplegada como microservicio
interno. Es decir, no expuesta directamente a usuarios finales sino
a través de otro sistema o un API gateway: no realiza autenticación
ni autorización de requests.
## Ejecución
### Build local + DB usando docker-compose
Iniciar DB
```
docker-compose up db
```
si hubiera que reiniciarla desde 0, ejecutar previamente `docker-compose down`.
Build de la app:
```
make build
```
Ejecutar:
```
./mtz-crypto-service
```
Luego, acceder a http://localhost:8000/wallet/value?wallet=wallet1
## Ejecución de tests
```
make test
```
## Documentación
### Arquitectura
### Flujo de datos
### Diseño
### Tecnología empleada / librerías
- HTTP Server: [gin](https://github.com/gin-gonic/gin)
- Cache en memoria: [go-cache](https://github.com/patrickmn/go-cache)
- Configuración: [viper](https://github.com/spf13/viper)
- Acceso a base de datos: [gorm](https://github.com/go-gorm/gorm)
- Métricas: [go-gin-prometheus](https://github.com/zsais/go-gin-prometheus)
- Logging: [zap](https://github.com/uber-go/zap)
- Arbitrary-precision fixed-point decimal numbers: [decimal](https://github.com/shopspring/decimal)
- Tests automáticos y mocks: [testify](https://github.com/stretchr/testify)
- Generación de código de mocks: [mockery](https://github.com/vektra/mockery)
- HTTP Benchmarking tool: [h2load](https://nghttp2.org/documentation/h2load-howto.html)
- Linting: [`golangci-lint`](https://github.com/golangci/golangci-lint)
- [Docker](https://docs.docker.com/) y [Docker compose](https://docs.docker.com/compose/)
## Links útiles
- [Instalación de Go](https://golang.org/doc/install)
- [Visual Studio Code (IDE)](https://code.visualstudio.com/)
- [Instalación de Docker](https://docs.docker.com/get-docker/)
- [Instalación de Docker Compose](https://docs.docker.com/compose/install/)
- [VSCode Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go)
- [Documentación de Go](https://golang.org/doc/)
- [pkg.go.dev](https://pkg.go.dev/)
- [Gitlab CI config](https://docs.gitlab.com/ce/ci/quick_start/)
## Código fuente de las clases
- Clase 1: [commit inicial](https://github.com/matbarofex/mtz-crypto/commit/2dc8b070190a97135e1bf2c66a6d3c98ca877087)
- Clases 2 y posteriores: https://github.com/matbarofex/mtz-crypto/pulls?q=is%3Apr+is%3Aclosed+label%3Aclases