spring-chat

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #typescript #llm #go #machine-learning #docker #nodejs #cli #kubernetes #pytorch #openai

(★ 14)

Horizontal scalable chat application using SpringBoot and Server Sent Event/WebSocket.

spring-chat Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# spring-chat

[![build](https://github.com/joejoe2/spring-chat/actions/workflows/main.yml/badge.svg)](https://github.com/joejoe2/spring-chat/actions/workflows/main.yml)

## Description

This is a horizontal scalable chat application using [Nats](https://github.com/nats-io/nats-server) as event bus.
You can add as many application instances as you need to increase the capacity of
online users in overall system. If you have even more users you can add Nats
servers as cluster to increase the message delivery speed/throughput.

## Features

- chat in public channels with any users (1 connection/channel)
- chat in private channels with another user (1 connection/user)
- chat in group channel with members (1 connection/user)
- user blockage in private channels

## Supported Protocols

You can use below protocols to receive/subscribe chat messages from the server:

- Server Sent Event
- Websocket

## Notice

This project is using [our another project](https://github.com/joejoe2/spring-jwt-template)
as authentication service for JWT authentication.

## Architecture

![image](https://raw.githubusercontent.com/joejoe2/spring-chat/main/architecture.png)

You can see technical details at [here](./doc/chat-detail/README.md).

## Online demo

[https://frontend.joejoe2.com](https://frontend.joejoe2.com)

## Example Frontend

We provide an example frontend application written in Vue.js [at here](https://github.com/joejoe2/chat-frontend) to
work with this project.

- chat in public channel
  ![image](https://raw.githubusercontent.com/joejoe2/spring-chat/main/demo_public_chat.png)
- chat in private channel
  ![image](https://raw.githubusercontent.com/joejoe2/spring-chat/main/demo_private_chat.png)
- chat in group channel
  ![image](https://raw.githubusercontent.com/joejoe2/spring-chat/main/demo_group_chat.png)

## Testing

run `mvn test` or `./mvnw test`

## Lint

run
```
mvn spotless:apply
``` 
or
```
./mvnw spotless:apply
```

## Deploy

1. follow [this](https://github.com/joejoe2/spring-jwt-template#deploy)
   to setup

2. copy `./env/application-chat.env.example` to `./env/application-chat.env`
   and set `jwt.secret.publicKey` as in 1.

3. prepare 2 FQDNs (ex. `chat.test.com`, `auth.test.com`)

4. open `./nginx/user_conf.d/server.conf` to
   replace `chat.example.com` and `auth.example.com` with your 2 FQDNs

5. `docker-compose up` or `docker-compose up -d`

spring-chat

spring-chat Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

spring-chat

spring-chat Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README