Comment Reader

Comment Reader é uma aplicação que permite a criação de comentários e a leitura do comentário por voz. Desenvolvido utlizando React.Js e NodeJS na linguagem Typescript.

Frameworks e Libs

• React.js
• Node.js
• Express JS
• IBM Watson

Pré-requisitos

Essas instruções fornecerão uma cópia do projeto completo instalado e funcionando em sua máquina local para fins de desenvolvimento e teste.

O projeto pode ser executado com npm ou yarn, então escolha uma das abordagens abaixo caso você não tenha nenhum instalado em seu sistema.

• Para rodar o projeto, você precisa instalar o NodeJS na sua máquina.

• Você precisa de uma conta na IBM Cloud para obter sua API_KEY e URL.

• Npm é distribuído com o Node.js, o que significa que quando você baixa o Node.js, o npm é instalado automaticamente no seu computador. Download Node.js

• O Yarn é um gerenciador de pacotes criado pela equipe do Facebook e costuma ser mais rápido que o npm em geral. Download Yarn

Banco de Dados e Docker

O Projeto usa MySql executando em um container do Docker.

Segue o link para baixar e configurar o docker: install docker.

Com o docker instalado, você precisa criar um container do MySql no Docker.

Em um terminal, execute:

$ sudo docker run --name smarkio_mysql -e MYSQL_ROOT_PASSWORD=docker -p 3306:3306 -d mysql --default-authentication-plugin=mysql_native_password

Esse comando criará um container chamado smarkio_mysql com a senha docker e a porta padrão do mysql 3306.

Após finalizar a criação, execute $ sudo docker ps e verifique se o container está em execução, se não estiver, execute $ sudo docker start smarkio_mysql.

Agora você precisa se conectar e criar um banco de dados manualmente no container do docker, você pode utilizar o DBeaver ou o BeeKeeper para gerenciar seus bancos de dados.

Para as configuraões de conexão, você precisa inserir as seguintes opções:

 Type: MySql
 Host: localhost
 Port: 3306
 User: root
 Password: docker

Após se conectar, crie um banco de dados chamado smarkio_test.

Instalação

• Para baixar o projeto siga as instruções abaixo:

Backend (API)

$ git clone https://github.com/mpvinnie/comment_reader.git
$ cd comment_reader/server

• Instale as dependências e inicie o projeto:

$ yarn
$ yarn dev

ou

$ npm install
$ npm dev

FrontEnd (React)

• Com o projeto já clonado entre no diretório do app

$ cd comment_reader/web

• Instale as dependências e inicie o projeto:

$ yarn
$ yarn start

ou

$ npm install
$ npm start

Renomeie o arquivo .env.example to .env que está em server e adicione suas credenciais de acesso à API do IBM Watson mencionado no pré-requsito.

Isso é tudo! =)

Licença

MIT