- Sobre o projeto
- Funcionalidades
- Demonstração da aplicação
- Como executar o projeto
- Tecnologias
- Autor
- Licença
Aplicativo de salas de conversas com comunicação em tempo real através de websockets. Totalmente responsivo, possui uma versão adaptada para mobile.
As seguintes funcionalidades estão disponíveis:
-
os usuários registrados podem:
- listar todos os usuários registrados, e se preferir, filtrá-los
- iniciar uma conversa com outro usuário e mandar mensagens
A aplicação está hospedada no Heroku
Este projeto é divido em duas partes:
- Backend (pasta src)
- Frontend (pasta client)
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e Yarn. Além disso, terá que ter o PostgreSQL para ter acesso a um banco de dados próprio.
# Clone este repositório
$ git clone https://github.com/lucasgbsampaio/chatroom-app.git
# Acesse a pasta do projeto no terminal/cmd para ter acesso a raiz da pasta
$ cd chatroom-app
# Instale as dependências
$ yarn
# Crie um arquivo .env na raiz seguindo as especificações do arquivo sample.env,
# colocando suas credencias do seu banco de dados
# Rode as migrações do banco de dados
$ yarn sequelize db:migrate
# Acesse a pasta src e vá para server.js
# em cors coloque a origin http://localhost:3000,
# que será a porta onde o client será hospedado
# Execute a aplicação em modo desenvolvimento
$ yarn dev
# O servidor iniciará na porta:5000 - acesse http://localhost:5000
# Acesse a pasta do frontend no seu terminal/cmd
$ cd client
# Instale as dependências
$ yarn
# Execute a aplicação
$ yarn start
# A aplicação será aberta na porta:3000 - acesse http://localhost:3000
As seguintes ferramentas foram usadas na construção do projeto:
Website (React)
Veja o arquivo package.json
Server (NodeJS)
Veja o arquivo package.json
Este projeto está sob a licença MIT.