danielizham/crypto-app repository overview

⁠Setup

Make sure Docker and Docker Compose are installed on your system. To verify, enter the following commands on your terminal:

$ docker -v
$ docker-compose -v

If any of them returns an error, follow the instructions on this link⁠ for the Docker installation and this link⁠ for the Docker Compose one.

⁠Running the app

The app can be run in two ways: for demonstration and production purposes. The only difference between them is that the former runs two instances of the app on the same machine while the latter on two different machines as how the app is intended to be used. The former way can also be used for testing and development.

⁠Demonstration

In an empty directory, run the following command to download the docker-compose.yml file:

$ curl -O https://gist.githubusercontent.com/danielizham/805341f4981ff2965cb186b3479e7da5/raw/docker-compose.yml

Then, to start the app, run:

$ docker-compose up -d

In the special circumstances that the app gets updated, run this instead:

$ docker-compose pull && docker-compose up -d

On a browser, go to the address http://localhost:5001 on one tab and http://localhost:5002 on another. The two addresses represent User 1 and User 2 respectively on two separate machines.

⁠Production

The instructions to run the production version are exactly the same as above except for the first and last steps:

1. Download a different docker-compose.yml file:

$ curl -O https://gist.githubusercontent.com/danielizham/acbfceb31ae367b4710003906612fa21/raw/docker-compose.yml

1. Use the address http://localhost:5000 on both machines.

⁠Closing the app

Remember to shut down the containers by running the following command in the same directory:

$ docker-compose down

Otherwise, other applications will not be able to use ports 5001 and 5002 (or 5000 if the production version is run).

⁠Credits

• Yousseif Elshahawy for the bulk of the effort on making this app work

• The rest of the group