Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zarifmahfuz authored Feb 12, 2022
1 parent 896a7f8 commit 00324e0
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@
# ChatApp
Simple multiparty chat application based on websockets

# Build

## Requirements

The Chat Application will be hosted on your local host! All you need to install is [Docker Engine](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/).

## Run

Ensure that your docker engine is running. From the top level directory of this git repository run the following command:

```
docker-compose up -d
```

This command will build the images of all the application services and it will launch all the services.

To stop the application and delete all the containers:
```
docker-compose down
```

To temporarily stop the application, but keep the containers and their associated data:
```
docker-compose stop
```

0 comments on commit 00324e0

Please sign in to comment.