Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Typo + grama #763

Merged
merged 3 commits into from
Feb 1, 2019
Merged

Typo + grama #763

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9ff4ab
Typo + grama
krhubert Jan 31, 2019
e40b302
Apply suggestions from code review
ilgooz Jan 31, 2019
269edc9
Merge branch 'master' into fix/readme-2
NicolasMahe Feb 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To help us build and maintain MESG Core, refer to the [Contribute](#contribute)

# Quick Start Guide

This guide will show you steps-by-step how to create an application that sends a Discord invitation email when a webhook is called.
This guide will show you step-by-step how to create an application that sends a Discord invitation email when a webhook is called.

### 1. Installation

Expand All @@ -62,23 +62,23 @@ You need to deploy every service your application is using.

In this guide, the application is using 2 services.

Let's start by deploying the [webhook service](https://github.com/mesg-foundation/service-webhook):
Start by deploying the [webhook service](https://github.com/mesg-foundation/service-webhook):

```bash
mesg-core service deploy https://github.com/mesg-foundation/service-webhook
```

Now let's deploy the [invite discord service](https://github.com/mesg-foundation/service-discord-invitation):
Deploy the [invite discord service](https://github.com/mesg-foundation/service-discord-invitation):

```bash
mesg-core service deploy https://github.com/mesg-foundation/service-discord-invitation
```

Once the service is deployed, the console displays its Service ID. The Service ID is the unique way for the application to connect to the right service through MESG Core. You'll need to use them inside the application.
Once the service is deployed, the console displays its Service ID. The Service ID is a unique way for the application to connect to the right service through MESG Core. You'll need to use them inside the application.
krhubert marked this conversation as resolved.
Show resolved Hide resolved

### 4. Create the application

Now that the services are up and running, let's create the application.
Now when the services are up and running, let's create the application.

The application is using [NodeJS](https://nodejs.org) and [NPM](https://www.npmjs.com/).

Expand All @@ -90,7 +90,7 @@ Create and move your terminal to a folder that will contain the application. The
npm init && npm install --save mesg-js
```

Now, let's create an `index.js` file and with the following code:
Now, create an `index.js` file and with the following code:

```javascript
const mesg = require('mesg-js').application()
Expand Down Expand Up @@ -131,12 +131,12 @@ Don't forget to replace the values `__YOUR_EMAIL_HERE__` and `__SENDGRID_API_KEY

### 5. Start the services

Let's start the webook service:
Start the webhook service:
```bash
mesg-core service start webhook
```

Then let's the start discord invitation service:
Start discord invitation service:
```bash
mesg-core service start discord-invitation
```
Expand All @@ -153,7 +153,7 @@ node index.js

Now let's give this super simple application a try.

Let's trigger the webhook with the following command:
Trigger the webhook with the following command:

```bash
curl -XPOST http://localhost:3000/webhook
Expand All @@ -173,7 +173,7 @@ Services implement two types of communication: executing tasks and submitting ev

Tasks have multiple input parameters and multiple outputs with varying data. A task is like a function with inputs and outputs.

Let's take an example of a task that sends a email:
Let's take an example of a task that sends an email:

The task accepts as inputs: `receiver`, `subject` and `body`.

Expand All @@ -191,9 +191,9 @@ Check out the documentation for more information on [how to create tasks](https:

Services can also submit events to MESG Core. They allow two-way communication with MESG Core and Applications.

Let's say the service is a HTTP webserver. An event could be submitted when the webserver receives a request with the request's payload as the event's data. The service could also submit a specific event for every route of your API.
Let's say the service is an HTTP web server. An event could be submitted when the web server receives a request with the request's payload as the event's data. The service could also submit a specific event for every route of your API.
krhubert marked this conversation as resolved.
Show resolved Hide resolved

For more info how to create your events, visit the [Emit an Event](https://docs.mesg.com/guide/service/emit-an-event.html) page.
For more info on how to create your events, visit the [Emit an Event](https://docs.mesg.com/guide/service/emit-an-event.html) page.
NicolasMahe marked this conversation as resolved.
Show resolved Hide resolved


# Architecture
Expand Down