https://github.com/alejandrosuero/real-time-chat

https://github.com/alejandrosuero/real-time-chat

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/alejandrosuero/real-time-chat
• Owner: AlejandroSuero
• Created: 2023-10-20T10:23:29.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-20T20:25:12.000Z (about 1 year ago)
• Last Synced: 2024-10-19T11:15:52.639Z (2 months ago)
• Language: TypeScript
• Size: 49.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 💬 Real time chat application

This application will display messages from users on the client, where all users can interact with

each other at the same time.

For real time interaction, I will be using [NodeJS](https://nodejs.org/) and [WebSockets](https://wikipedia.org/wiki/WebSocket), specifically, [socket.io](https://socket.io/).

## 🛠️ Features

- Server:

  - TypeScript

  - [express](https://expressjs.com/)

  - [socket.io](https://socket.io/)

  - Database:

    - libSQL, a SQLite fork from [turso](https://turso.tech/)

- Client:

  - HTML

  - CSS

  - JavaScript

## 🤔 How to use

### 🏠 Locally

Clone the repository and build the application.

In order to do it, you will need to have installed:

- [Git](https://git-scm.com/)

- [Node](https://nodejs.org/)

Create an account in [turso](https://turso.tech/) and create a database, more info in the [docs](https://docs.turso.tech/)

Then, open your terminal and execute this commands:

```bash

git clone https://github.com/AlejandroSuero/real-time-chat.git

cd real-time-chat

# inside real-time-chat directory

# create a .env file to store your DB information

touch .env

npm install

npm run build

npm start

```

> NOTE: check the [.env.example](https://github.com/AlejandroSuero/real-time-chat/blob/main/.env.example)

> to store your DB information

Then go to http://localhost:3000/ and follow enjoy your chats with other people.

### 🛜 On the site

It is just a chat application, you can view other people messages, write your own messages and enjoy your time there 😊