📚 Table of contents

1. Installation
2. Testing
3. File Structure Overview

Installation

The following technologies are required and expected to be already installed on the host system:

• Git
• Docker
• Make

Clone the repository:

$ git clone git@github.com:guilhermeIO/hash-monorepo.git

Inside the infrastructure directory, provision the infrastructure:

$ make up

Testing

Inside the infrastructure directory, test all services:

$ make test

To test a specific service, just follow the command pattern make {SERVICE NAME}-test. Example:

$ make products-discount-test

Repository Structure Overview

Services

Each service lives on it's own directory and is prefixed with it's main language (i.e. node-products-discount, php-http-api).

Protocol Buffers

All protocol buffer files reside in the protobufs directory.

Infrastructure

Holds the file that composes the whole infrastructure for the development environment (docker-compose.yaml).

Also, provides a collection of useful commands - located at the file Makefile.

ℹ️ Each service holds it's infrastructure specification under it's own _docker folder.

TODOS

• Add .env file for Docker and Apps (best practice for sensitive data)
• Add MingoDB dump, to seed database on setup