platzily/dealer

https://storage.googleapis.com/gopherizeme.appspot.com/gophers/521763cdaf44ed25cc34c1edfbc4b2f1e480bb8a.png

Platzily

Development environment

This part of the documentation assumes that you have docker-compose installed

On the root of the project run the following command

cat .env.example > .env

Fill all the environment variables on the .env file

yarn start:database

Wait for the databases to fill and run the following command

yarn dev

Now you should have

• A container running mongo on port 27017
• A container running the api-gw on port 3100
• A hot reloading api-gw process running on port 3000

dealer's Issues

Create Dealer [8]

Test - create basic test suite

Checklist ✅

• The issue is present in the latest release.
• I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

We need a basic tests suite to test the core components of the code such as the drivers since now we "test" those drivers by manual and by writing code on main.go that shouldn't be there

Requirements 🌈

Create tests that covers at least the drivers and its methods. Integration tests are a nice to have.

Motivation 🔦

Testing is a fundamental part of the development flow and it is necessary to prove that new feature will not break the current code.

Feature - event useCase

Checklist ✅

• The issue is present in the latest release.
• I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

The use case should be able to connect to the main queue and be always listening when a new message comes to send it to the respective consumer (e.g. email, slack).

It has to create a new record on the state machine (DB) to keep track of the notifications status.

Requirements 🌈

• Connect to the main queue (RabbitMQ Queue)
• Connect to the state machine (MongoDB)
• Connect to the consumer queue (RabbitMQ Queue)

Motivation 🔦

We need this feature in order to accomplish the MVP of the project, also, with this feature we are going to be able to make testing of the whole workflow of a event (notification).

Create scaffold of the project

We have to define the right scaffold for the project. This means creating all the folders and basic files so we can have a firm base.

Create dealer and consumer services

We have to create the first two core services. The dealer will be in charge of managing all the notifications and the consumer will parse this notification to send it to an API of an external service (e.g Slack).

Chore - dotenv capabilities

Checklist ✅

• The issue is present in the latest release.
• I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

In order to make the project work, we will just need a .env file that will contain all the sensible or editable parameters, such as passwords, configurations, etc.

Requirements 🌈

Add a dotenv package like godotenv and a .env.example as a reference to know all the necessary variables to run the project successfully.

Motivation 🔦

With this, the project will be easier to run on any environment or machine, also the CI/CD flows will be easier to implement with this feature