Skip to content

Commit 6929282

Browse files
committed
Update README with info about docker-compose version
1 parent 68df770 commit 6929282

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,37 @@
1-
# Nutanix Python API Lab v1.2 - Complete Demo
1+
# Nutanix Python API Lab v1.3 - Complete Demo
22

33
This Python Flask demo app is designed as a complete working version of the dashboard created in the [Nutanix Python Flask and Prism REST API lab](https://www.nutanix.dev/labs/).
44

55
Rather than download this complete app and run it standalone, new users are recommended to follow the lab so that all components and concepts are appropriately communicated.
66

77
Those with Python Flask experience are welcome to download this demo and use as they see fit, of course.
88

9+
## Versions
10+
11+
Bundled with this repo is a version that can be run using `docker-compose`:
12+
13+
- Ensure `git` is installed locally and available in a terminal
14+
- Clone this repo:
15+
16+
```
17+
git clone https://github.com/nutanixdev/python-api-lab-demo
18+
```
19+
20+
- [Install docker-compose](https://docs.docker.com/compose/install/) on your system (this process is beyond the scope of this repo)
21+
- Checkout the `compose` branch:
22+
23+
```
24+
git checkout compose
25+
```
26+
27+
- Launch the app:
28+
29+
```
30+
docker-compose up -d --build
31+
```
32+
33+
**Notes:** The docker-compose version of this app uses host networking. The configuration of alternative networking is also beyond the scope of this repo, although host networking has been chosen to ensure connectivity via VPN is available in our development environment.
34+
935
## License
1036

1137
Please see the accompanying `LICENSE` file that is distributed with this repository.

0 commit comments

Comments
 (0)