Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/larien/product
This is an implementation of services communication via gRPC, using Docker, different testing approaches, and other topics like mocking, relational database, API.
https://github.com/larien/product
docker golang grpc mocking nodejs postgresql testing
Last synced: 1 day ago
JSON representation
This is an implementation of services communication via gRPC, using Docker, different testing approaches, and other topics like mocking, relational database, API.
- Host: GitHub
- URL: https://github.com/larien/product
- Owner: larien
- License: gpl-3.0
- Created: 2021-02-15T18:27:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-02-19T23:43:19.000Z (over 3 years ago)
- Last Synced: 2024-06-19T05:22:21.191Z (4 months ago)
- Topics: docker, golang, grpc, mocking, nodejs, postgresql, testing
- Language: Go
- Homepage:
- Size: 92.8 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Product Service
Product Service is an implementation of services communication via gRPC and HTTP requests. Some technologies used here are Golang, Node.JS, gRPC, PostgreSQL, Docker and Docker Compose and many others.
These services were designed according to [Hash's hiring test](https://github.com/hashlab/hiring). To understand each service and its technical decisions, please access each service's README:
- [Product](product/README.md)
- [Discount](discount/README.md)
## Project structure
- **discount**: service 1 implementation, written in Node.JS
- **migrations**: contains the database migration scripts and it's used along golang-migrate
- **product**: service 2 implementation, written in Golang
- **protos**: contains the protobuf scripts and generated code for gRPC communication
## Installation
Install [**docker**](https://docs.docker.com/get-docker/) and [**docker-compose**](https://docs.docker.com/compose/) and build the images.
```bash
docker-compose build
```
## Usage
Export the necessary environment variables (hint: save them to a `.env` file and run `export $(xargs <.env)`). Below there are a few to get you started:
```bash
DB_USER=larien
DB_HOST=database
DB_PORT=5432
DB_NAME=product
DB_PASSWORD=lauren123
LOG_LEVEL=1
PORT=:8080
POSTGRESQL_URL=postgres://larien:lauren123@database:5432/product?sslmode=disable
GRPC_PORT=:50051
GRPC_HOST=0.0.0.0
```
Run the built images (include `-d` if you don't want to read the logs in your terminal)
```bash
docker-compose up --remove-orphans
```
## Tips and tricks
### Connecting to the database inside the container
```bash
docker exec -it database bash
su - postgres
psql -p 5432 -d -U
```
Happy inserting!
## Authors and acknowledgment
Lauren Ferreira - [larien.dev](larien.dev)
## Contributing
Pull requests are welcome, but there is no development planned for this project.
## License
[GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/)