https://github.com/socketio/socket.io-chat-platform

A basic chat platform based on Socket.IO
https://github.com/socketio/socket.io-chat-platform

javascript nodejs socket-io websocket

Last synced: 3 months ago
JSON representation

A basic chat platform based on Socket.IO

• Host: GitHub
• URL: https://github.com/socketio/socket.io-chat-platform
• Owner: socketio
• License: mit
• Created: 2023-12-22T18:30:32.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-12T11:29:36.000Z (12 months ago)
• Last Synced: 2024-09-29T01:02:43.891Z (3 months ago)
• Topics: javascript, nodejs, socket-io, websocket
• Language: JavaScript
• Homepage: https://socket.io
• Size: 413 KB
• Stars: 72
• Watchers: 4
• Forks: 24
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Socket.IO chat platform

A basic chat platform based on [Socket.IO](https://socket.io/) with:

- channel-based messages:

![Screenshot of a public channel](./assets/channel_based_messages.png)

- and private messages:

![Screenshot of a private channel](./assets/private_messages.png)

Table of contents:

* [How to use](#how-to-use)

* [Development](#development)

  * [Server](#server)

  * [Client](#client)

* [Data model](#data-model)

* [Licence](#licence)

## How to use

```shell

$ docker compose up -d

```

Then go to http://localhost:8080

## Development

### Server

```shell

$ cd server

# start the PostgreSQL database

$ docker compose up -d

# start the server

$ npm run dev

```

### Client

```shell

$ cd vue-client

# start the client

$ npm run dev

```

Then go to http://localhost:5173

## Data model

  

  

## Licence

[MIT](./LICENSE)