Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sergio-id/go-notes
Go Notes using gRPC Gateway, Docker and Helm
https://github.com/sergio-id/go-notes
docker docker-compose go golang grpc grpc-gateway helm k8s postgresql postman redis
Last synced: about 2 months ago
JSON representation
Go Notes using gRPC Gateway, Docker and Helm
- Host: GitHub
- URL: https://github.com/sergio-id/go-notes
- Owner: sergio-id
- License: mit
- Created: 2023-09-11T11:57:56.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-09-11T12:38:49.000Z (over 1 year ago)
- Last Synced: 2024-10-12T11:21:01.042Z (3 months ago)
- Topics: docker, docker-compose, go, golang, grpc, grpc-gateway, helm, k8s, postgresql, postman, redis
- Language: Go
- Homepage:
- Size: 912 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go Notes example
### Tech stack:
* [GRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway) - gRPC Gateway
* [GRPC](https://grpc.io/) - gRPC
* [Protobuf](https://developers.google.com/protocol-buffers) - Protobuf
* [Wire](https://github.com/google/wire) - Automated Initialization in Go
* [SQLC](https://github.com/kyleconroy/sqlc) - A SQL Compiler
* [Go-redis](https://github.com/go-redis/redis) - Redis client for Golang
* [Zap](https://github.com/uber-go/zap) - Logger
---
* [Docker](https://www.docker.com/) - Docker
* [Docer Compose](https://docs.docker.com/compose/) - Docker Compose
* [Helm](https://helm.sh/) - Helm
* [k8s](https://kubernetes.io/) - k8s
* [GitHub Actions](https://github.com/features/actions) - GitHub Actions (_for lint and unit tests_)
---
* [Postman Collection](https://www.postman.com/) - Postman Collection (_third_party/PostmanCollection_)
* [OpenAPI](https://swagger.io/specification/) - OpenAPI (_third_party/OpenAPI_)
---
* [Excalidraw](https://excalidraw.com) - Excalidraw for diagrams
---
### Usage local:
```bash
make docker-up // run all containers with application
```
The service is available at http://localhost:5555/v1/api. You can check it using Postman by importing the collection
located at `third_party/PostmanCollection/Notes.postman_collection.json`.
### Stop containers:
```bash
make docker-down // stop containers
```
---
### TESTS
### 1. Postman
To import a collection into Postman, you should use the `Import` button in the top-left corner of the Postman window.
Before running the tests, it's necessary to set the required environment variables:
`baseUrl`: the address of the server where the project is running.
Example: `http://localhost:5555/v1/api`
To run the tests in Postman, you should select the collection (`Notes -> Tests`), and then click the
button (`Run folder -> Run Notes`).
The passed tests will appear as follows:
---
### Unit tests
```bash
make test-run // run unit tests
```
---
## k8s
To deploy the project in Kubernetes (k8s), Helm is used.
```bash
cd .charts/go-notes/proxy && \
helm dependency update && \
helm install -f values.yaml go-notes .
```
---
### Checking the Swagger documentation:
Take the generated file `{{service}}.swagger.json` from the `third_party/OpenAPI` directory.
Paste it into the [Swagger Editor](https://editor.swagger.io).
