https://github.com/gbzarelli/pgen
[GO] PGen is a microservice that generates random and unrepeatable protocols with easy readability.
https://github.com/gbzarelli/pgen
go go-api go-gin go-prometheus go-redis golang redis
Last synced: about 1 month ago
JSON representation
[GO] PGen is a microservice that generates random and unrepeatable protocols with easy readability.
- Host: GitHub
- URL: https://github.com/gbzarelli/pgen
- Owner: gbzarelli
- License: apache-2.0
- Created: 2021-12-12T01:46:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-20T22:04:09.000Z (over 4 years ago)
- Last Synced: 2025-03-15T13:24:36.764Z (over 1 year ago)
- Topics: go, go-api, go-gin, go-prometheus, go-redis, golang, redis
- Language: Go
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.codacy.com/gh/gbzarelli/pgen/dashboard?utm_source=github.com&utm_medium=referral&utm_content=gbzarelli/pgen&utm_campaign=Badge_Grade)
# PGen (building... learning GO Lang...)
Unrepeatable Protocol generator API in GO.
The PGen is a microservice created to generate service protocols for any type of services.
These protocols are readable so that people can easily record
The protocol number consists of 16 digits (by default), the first 8 (fixed) being the current date
and the last (configurable) random:
Format: 'YYYYMMDD????????' sample: 2021120912345678
# Technologies
- [Gin - Go Web Framework](https://github.com/gin-gonic/gin)
- [Redis - KV NoSQL for Cache](https://github.com/go-redis)
- [Testify - Asserts and Mocks](https://github.com/stretchr/testify)
- [Metrics - GinProm by Depado](https://github.com/Depado/ginprom)
# Instructions to Run
### Prepare
- Clone de project:
- `git@github.com:gbzarelli/pgen.git`
- Go to `pgen` directory:
- `$cd pgen/`
- Build project
- Prepare dependencies
- `$make dependencies`
- Build project
- `$make build`
### Run with Docker
- Generate Dockerfile
- `$make build-docker`
- Run full stack:
- `$make run-docker-compose`
### Run in project
- Run the dependencies (infra / redis):
- `$make run-docker-stack`
- Run project
- `$go run main.go`
### Envs
Custom the decimal places value to generate a new protocol (default 8):
- `PROTOCOL_DECIMAL_PLACES_AFTER_DATE`
- Default in Project and Dockerfile: 8
Custom Redis address:
- `REDIS_ADDRESS`
- Default in Project: localhost:6379
- Default in Dockerfile: redis:6379
## API
The project starts in `localhost:5000` with a unique endpoint to generate a new protocol:
## Endpoint: v1/protocol
#### Request:
```shell
curl --request POST --url http://localhost:5000/v1/protocol
```
#### Response:
```json
201 {"protocol": "2021121204066844"}
```
## Metrics by prometheus
#### View metrics by app
```shell
curl --request GET --url http://localhost:5000/metrics
```
#### Prometheus
If you run by docker just open prometheus in: `http://localhost:9090/`