An open API service indexing awesome lists of open source software.

https://github.com/ramonpaolo/chat-realtime

Real time chat using Socket.io and NodeJs.
https://github.com/ramonpaolo/chat-realtime

ejs expressjs javascript nodejs socket-io typescript

Last synced: 4 months ago
JSON representation

Real time chat using Socket.io and NodeJs.

Awesome Lists containing this project

README

          

# Portfolio

![Realtime Chat](https://ik.imagekit.io/9t3dbkxrtl/realtime-chat_J9ZFNOPTf.gif?ik-sdk-version=javascript-1.4.3&updatedAt=1652364172872)

## Languages Translates
- [Portuguese](#portuguese)
- [English](#english)

# English

##### Ops: this translate was made by me(Ramon Paolo Maran). Sorry for any problem in translate : )

## Index
- [About the Project](#abouttheproject-english)
- [How it's works?](#howwork-english)
- [Technologies Useds](#technologiesuseds-english)
- [How execute this project?](#howexecute-english)
- [Tips](#tips-english)

---

# 📑 About the Project

The project consist in are the chat in realtime, in that those people can use with security, because the datas not is saved in databases or cache.

---

# How it's works?

I'm using EJS to do the frontend, in the side of server(NodeJs), that are get the datas of Socket.io and making a broadcas for all machines that listening one determined room.

The network use cryptograph peer-to-peer with HTTPS

---

# 🚀 Technologies Useds
- TypeScript
- NodeJs
- Express
- EJS
- Socket.io

---

# 📁 How Execute this Project?
Requirements: NodeJs 14.17 LTS and Yarn

```bash
# clone the repositore
$ git clone https://github.com/ramonpaolo/chat-realtime

# enter inside the folder of project
$ cd chat-realtime/

# install the dependencies:
$ yarn

# build the application:
$ yarn build

# init the project:
$ yarn start
```

---

# Tips

Warning with people in the room, using cell phone, because, some files can break the navigator in cell phone.

---

# Portuguese

---

## Índice
- [Sobre o Projeto](#abouttheproject-portuguese)
- [Como Funciona?](#howwork-portuguese)
- [Tecnologias Usadas](#technologiesuseds-portuguese)
- [Como executar o Projeto?](#howexecute-portuguese)
- [Dicas](#tips-portuguese)

---

# 📑 Sobre o Projeto

O projeto consiste em um chat em tempo real, no qual as pessoas podem usar com segurança, pois os dados não são gravados

---

# Como Funciona ?

Eu estou usando o EJS para fazer o HTML do frontend, no lado do servidor(NodeJs), que está pegando como parâmentos os dados do Socket.io e fazendo um broadcast para todas as máquinas que estão ouvindo uma determinada sala.

A rede usa criptografia de ponta a ponta com HTTPS

---

# 🚀 Tecnologias Utilizadas
- TypeScript
- NodeJs
- Express
- EJS
- Socket.io

---

# 📁 Como executar o projeto?
Pré-requesitos: NodeJs 14.17 LTS e Yarn

```bash
# clonar repositório
$ git clone https://github.com/ramonpaolo/chat-realtime

# entrar na pasta do projeto
$ cd chat-realtime/

# instalar as depêndencias:
$ yarn install

# buildar a aplicação:
$ yarn build

# iniciar o projeto:
$ yarn start
```

---

# Dicas

Cuidado ao mandar arquivos pesados na sala, e uma pessoa estiver usando o dispositovo móvel. Ele pode travar devido ao tamanho do arquivo no navegador.

![GitHub top language](https://img.shields.io/github/languages/top/ramonpaolo/chat-realtime)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/ramonpaolo/chat-realtime)
![GitHub](https://img.shields.io/github/license/ramonpaolo/chat-realtime)


# Make by Ramon Paolo Maran ❤