EnternessChat

O EnternessChat é um projeto desenvolvido utilizando as tecnologias TypeScript, Node, React com ViteJS e Socket.io.

Você pode testar neste ambiente: https://enterness-real-time-chat.vercel.app

🚀 OBJETIVO

O objetivo do projeto é criar uma plataforma de comunicação interativa e instantânea, onde os usuários possam trocar mensagens e informações de maneira imediata. Através da integração do Node.js para o lado do servidor e do React para a construção da interface do usuário, uma aplicação robusta e responsiva que permita aos usuários se conectarem em tempo real, trocar mensagens em grupos, e acompanhar a presença online dos outros participantes. Além disso, o projeto visa implementar recursos de notificações em tempo real, proporcionando uma experiência de chat completa e dinâmica para os usuários envolvidos.

💻 TECNOLOGIAS

Website (React + TypeScript)

• React Router Dom
• React Icons
• ViteJS
• I18Next
• Emoji Mart
• Socket.io Client

* Veja o arquivo package.json

Server (NodeJS + TypeScript)

• Express
• CORS
• Socket.io

* Veja o arquivo package.json

🍷 COMO UTILIZAR

Configurações Iniciais

Primeiro, você precisa ter o NodeJS instalado na sua máquina.

Você pode optar também por utilizar o yarn no lugar do npm. Você pode instalar clicando nesse link.

Executando o Server (Backend)

Este é o backend da aplicação. Ele utiliza tecnologias como Node.js, Express e Socket.IO para fornecer a funcionalidade de chat em tempo real.

1. Clone este repositório para o seu sistema local.
2. Navegue até o diretório raiz do projeto cd server.
3. Execute o seguinte comando para instalar as dependências:

npm install

ou caso estiver utilizando yarn:

yarn install

Scripts Disponíveis

- Compilação TypeScript (Build):

npm run build

ou caso estiver utilizando yarn:

yarn build

Este comando irá compilar o código TypeScript localizado na pasta src/ para JavaScript na pasta dist/. Ele também utiliza tsc-alias para manter os caminhos de importação mais organizados.

- Iniciar o Servidor

npm run dev

ou caso estiver utilizando yarn:

yarn dev

Isso iniciará o servidor Express e o servidor Socket.IO, permitindo que o aplicativo de chat funcione.

- Modo de Desenvolvimento

npm start

ou caso estiver utilizando yarn:

yarn start

Este comando é utilizado durante o desenvolvimento. Ele usa o nodemon para monitorar alterações nos arquivos na pasta src/ e reiniciar automaticamente o servidor sempre que houver alterações.

- Disponibilidade

Após executar o servidor em modo desenvolvimento ou após a build a aplicação ficará disponível em na porta local 4000.

Executando o Client (Frontend)

Este é o cliente da aplicação. Ele é construído utilizando tecnologias como React, Vite e Socket.IO para fornecer uma interface de usuário interativa para o aplicativo de chat em tempo real.

1. Clone este repositório para o seu sistema local.
2. Navegue até o diretório raiz do projeto cd client.
3. Inicialize as variáveis de ambiente com o comando cp .env.example .env
4. Execute o seguinte comando para instalar as dependências:

npm install

ou caso estiver utilizando yarn:

yarn install

Scripts Disponíveis

- Modo de Desenvolvimento:

npm run dev

ou caso estiver utilizando yarn:

yarn dev

Este comando inicia o servidor de desenvolvimento usando o Vite. Ele compila e carrega automaticamente as alterações à medida que você edita os arquivos do cliente. Acesse http://localhost:5173 em seu navegador para ver o aplicativo em execução.

- Compilar para Produção:

npm run build

ou caso estiver utilizando yarn:

yarn build

Este comando compila o aplicativo para produção. Os arquivos compilados serão armazenados na pasta dist/.

📃 LICENÇA

Esse repositório está licenciado pela MIT LICENSE. Para mais informações detalhadas, leia o arquivo LICENSE contido nesse repositório.

Feito por Daniel Luiz Alves