Messenger Chatbot

Orquestrador criado para lidar com requisicões do facebook messenger e conversar com o bot criado no Watson Assistant.

Getting Started

Essas intruções servirão para copiar o projeto e rodá-lo localmente para desenvolvimento. Veja deployment para saber como fazer o deploy do projeto na IBM Cloud.

Prerequisites

Quais coisas você precisa instalar e como instalá-las.

Node.js
- Baixe a versão recomendada para os usuários comuns e siga as intruções corretamente.
Facebook Developer Account
IBMCloud CLI
IBM Cloud Account
- Crie uma conta gratuita na IBM Cloud, isso será suficiente para suprir nossa necessidade
Watson Assistant Instance

Installing

1. Instalando as dependências

No terminal navegue até o diretório do projeto e execute:

  npm install
  ou
  yarn add

Esse comando instalará todos os pacotes listados no nosso package.json

2. Criar arquivo .env

* Caso não tenha API Keys, por favor revise a parte de Prerequisites

Com os serviços criados na IBM Cloud e as API Keys em mãos:

O arquivo .env é de extrema importância, porque é dele que toda a aplicação busca as credenciais, ele fica localizado no diretório root. Um modelo para todas as Chaves está localizado no .envexample

* O arquivo .env não subirá para o gitHub

3. Rodando localmente o servidor

Há alguns scripts disponibilizados para facilitar na hora do desenvolvimento

Esse comando rodará o servidor sem restartar automaticamente, a cada mudança será necessário parar o servidor no terminal e startar de novo.
```
  npm start
  ou
  yarn start
```
Esse comando rodará o servidor ouvindo todas as mudanças que fizer no código, ou seja, ele sempre irá restartar o servidor a cada mudança
```
  npm run server
  ou
  yarn server
```

Deployment

Veja Deployment.md

Built With

Node.js - Usado como runtime
Yarn - Usado como gerenciador de pacotes, como o npm(instalado por padrão pelo node.js)
Express - Usado como web Framework
ESLint - Usado para controle de escrita de código
Watson Assistant - Usado para chatbots personalizados
Facebook Developers

License

Esse projeto está licenciado sob a licença MIT - veja o arquivo LICENSE.md para mais detalhes.

xMr110/messengerBot