/lapislazuli-chat

Uma aplicação web de bate papo open source e sem fins lucrativos. Criado principalmente para por em pratica conhecimentos técnicos e trabalho em equipe.

MIT LicenseMIT

Contributors Issues MIT License


Logo

Lapislazuli Chat

Um lugar para conversar e criar novas amizades!

🚧 Em desenvolvimento 🚧


Conteúdo

💻 Sobre o projeto

O Lapislazuli Chat é uma aplicação web de bate papo open source e sem fins lucrativos. Criado principalmente para por em pratica conhecimentos técnicos e trabalho em equipe.

Com o objetivo de desenvolver um projeto em grupo que pudesse ser colocado no portfólio. Juntei alguns programadores para trabalhar junto comigo nessa aplicação. E ao final teremos um serviço de bate papo em tempo real.

O código deste repositório está livre para ser clonado e usado por qualquer pessoa. E se você sentir interesse pelo projeto, sinta se avontade para contruibuir conosco.


⬆️ Voltar ao topo ⬆️



⚙ Funcionalidades

Nesta aplicação é possivel criar uma conta pessoal e ter conversas privadas com outro usuário. Ou conversar em grupo com varios usuários ao mesmo tempo.

Lista de funções

  • Se cadastrar
  • Fazer login em sua conta
  • Adicionar outros usuários ao seus contatos
  • Criar e participar de grupos
  • Enviar e receber mensagens em tempo real

⬆️ Voltar ao topo ⬆️



🎨 layout

O design desse projeto foi criado no Figma, inspirado em redes sociais como o WhatsApp. E você pode acessa-lo através deste link.

Versão desktop

Versão mobile


⬆️ Voltar ao topo ⬆️



📚 Documentação

Você pode conferir a documentação do backend neste arquivo.


⬆️ Voltar ao topo ⬆️



🛠 Tecnologias

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


Frontend:

  • HTML
  • EJS
  • CSS
  • SASS
  • JavaScript

Backend:

  • NodeJS
  • Express
  • Sequelize
  • JWT
  • Jest
  • Socket.io

⬆️ Voltar ao topo ⬆️



🚀 Como executar o projeto

Para que a aplicação funcione na sua maquina você vai precisar ter instalado o Git e o NodeJS.

E após isso basta seguir os comandos:

# Clone este repositório
$ git clone https://github.com/MBrayanS/lapislazuli-chat.git

# Instale as dependências e execute a aplicação em modo de desenvolvimento com
$ npm install
$ npm run dev

# Ou se você estiver usando yarn
$ yarn 
$ yarn run dev

# E no terminal irá aparecer a porta em que está rodando o projeto.

⬆️ Voltar ao topo ⬆️



🌠 Contribuição

Você deseja contribuir com o projeto e não sabe como?

  • Faça um fork do projeto
  • Crie uma nova branch para fazer suas alterações
  • Salve as modificações e não se esqueça de usar o padrão de commit do projeto
  • E por fim envie as suas alterações através de um pull request

Antes de começar uma nova feature ou uma correção de bug. De uma olhada em issues para verificar se já não existe alguém trabalhando nisso.

E caso tenha sobrado alguma dúvida, você pode entrar em contato comigo.


⬆️ Voltar ao topo ⬆️



👨‍💻 Contribuidores


Hugo-Henrique7

joaopedrokleinprevidi

👷 Autor


MBrayanS

⬆️ Voltar ao topo ⬆️



📝 Licença

Este projeto esta sobe a licença MIT.