dbelarmino / thebot

The Bot - é uma aplicação de chatbot.

🚧 The Bot ♻️ Finalizado 🚀 🚧

Sobre • Funcionalidades • Como executar • Tecnologias • Contribuidores • Autor • Licença

💻 Sobre o projeto

♻️ The Bot - é uma aplicação de chatbot.

---

⚙️ Funcionalidades

• Usuário tem possibilidade de buscar um, buscar todos, cadastrar, atualizar e apagar o bot
• Usuário tem possibilidade de enviar mensagem, buscar por uma determinada mensagem e buscar todas as mensagens de uma determinada conversa.

---

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js + NPM, Yarn, Docker, Docker Compose e Insomnia Além disto é bom ter um editor para trabalhar com o código como VSCode

---

ℹ️ Como Utilizar

A partir da sua linha de comando:

Server

# Clone o repositório
$ git clone https://github.com/douglasbelarmino/thebot thebot

# Entre na pasta
$ cd thebot/server

# Instale as dependências
$ yarn

# Na raiz do pasta server, crie um novo arquivo chamado .env, copie o conteúdo do .env.example para dentro do .env e configure as variáveis de ambiente da seguinte forma:
MONGO_USERNAME=docker
MONGO_PASSWORD=docker
MONGO_DB=db_thebot

# Crie os containers do back-end e banco de dados
$ sudo docker-compose up -d

# Abra o programa insomnia e importe o arquivo 'Insomnia' disponível na pasta server. Logo em seguida, abra a request Bot/Store e execute a mesma. Se retornar o status code 201 é porque deu tudo certo.

Web

# Clone repositório
$ git clone https://github.com/douglasbelarmino/thebot thebot

# Entre na pasta
$ cd thebot/web

# Instale dependências
$ yarn

# Na raiz do pasta web, crie um novo arquivo chamado .env, copie o conteúdo do .env.example para dentro do .env e configure a variável de ambiente da seguinte forma:
REACT_APP_API_URL=http://localhost:3333

# Execute aplicação
$ yarn start

---

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Server (Node.js + TypeScript)

• Express
• Mongoose
• TS Node Dev
• Cors
• dotenv
• uuid

Veja o arquivo package.json

Web (ReactJS + TypeScript)

• React Router Dom
• Styled Components
• Axios

Veja o arquivo package.json

Utilitários

• Editor: Visual Studio Code

• Insomnia: Insomnia

• Markdown: Markdown Emoji

• Fontes: Poppins

---

👨‍💻 Contribuidores

Douglas Belarmino

💪 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

---

🦸 Autor

_{Douglas Belarmino}

---

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Douglas Belarmino 👋🏽 Entre em contato!

---