2019-03-13 00:31:49 +00:00
### Developing with Docker
The intention of the Docker configurations in this directory is to enable anyone to develop and test NuCypher on all major operating systems with minimal prerequisites and installation hassle.
#### quickstart
* install [Docker ](https://docs.docker.com/install/ )
* install [Docker Compose ](https://docs.docker.com/compose/install/ )
* cd to dev/docker (where this README is located)
* `docker-compose up` **this must be done once to complete install**
Then you can do things like:
* run the tests:
2019-03-28 22:41:45 +00:00
`docker-compose run nucypher-dev pytest`
2019-03-13 00:31:49 +00:00
* start up an ursula:
2019-03-28 22:41:45 +00:00
`docker-compose run nucypher-dev nucypher ursula run --dev --federated-only`
2019-03-13 00:31:49 +00:00
* open a shell:
2019-03-28 22:41:45 +00:00
`docker-compose run nucypher-dev bash`
2019-03-13 00:31:49 +00:00
* try some of the scripts in `dev/docker/scripts/`
**tested on (Ubuntu 16, MacOS 10.14, Windows 10)*
From there you can develop, modify code, test as normal.
### other cases
* run a network of three independent Ursulas
`docker-compose -f 3-ursulas.yml up`
* get the local ports these ursulas will be exposed on
`docker ps`
* to stop them...
`docker-compose -f 3-ursulas.yml stop`
2019-04-02 21:37:10 +00:00
2019-04-02 22:46:36 +00:00
## Pycharm (pro version only)
2019-04-02 21:37:10 +00:00
* You can configure pycharm to use the python interperter inside docker.
* docs for this are [here ](https://www.jetbrains.com/help/pycharm/using-docker-compose-as-a-remote-interpreter.html#docker-compose-remote )
