Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SeoulSKY authored May 29, 2024
1 parent a148ea9 commit f436def
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,18 @@
<img src="https://github.com/SeoulSKY/GoChat/actions/workflows/eslint.yml/badge.svg" alt="eslint">
</div>

## Screenshots
## Overview

### Chat Room
### Home

![](https://github.com/SeoulSKY/GoChat/blob/main/assets/home.gif)

<img src="https://github.com/SeoulSKY/GoChat/assets/48105703/c03988b8-9046-4f49-a158-9c081e97f54a">
### Chat Room

![](https://github.com/SeoulSKY/GoChat/assets/48105703/c03988b8-9046-4f49-a158-9c081e97f54a)

## How to run

This application requires `Docker` and `Docker compose`. Please install them first.
* [Docker installation](https://www.docker.com/get-started)
* [Docker compose installation](https://docs.docker.com/compose/install/)
Expand All @@ -31,6 +35,7 @@ docker-compose up --build -d
When it is ready, visit [here](http://localhost:8080)

## Architecture

![architecture](https://user-images.githubusercontent.com/48105703/147528514-619615f9-378a-4174-ab1a-ef13129e3631.png)

`Go` server and `React` server communicate via WebSocket. In addition, `Go` server provides a REST API to get all existing chats in the database.

0 comments on commit f436def

Please sign in to comment.