-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
896a7f8
commit 00324e0
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |