From cc52a893e7a286045bf6d18dc5b4cf6b88dab131 Mon Sep 17 00:00:00 2001 From: bry-c Date: Mon, 29 Jun 2020 23:23:19 +0900 Subject: [PATCH] Add DEVELOPMENT.md and update dev Dockerfile --- DEVELOPMENT.md | 37 +++++++++++++++++++++++++++++++++++++ docker/dev/Dockerfile | 2 +- docker/dev/requirements.txt | 2 -- 3 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 DEVELOPMENT.md delete mode 100644 docker/dev/requirements.txt diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 00000000..32aa78c1 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,37 @@ +# Development Guide + +## Docker local development setup + +You should have docker installed in your system, if not click [here](https://docs.docker.com/get-docker/). + +1. Go to diagrams root directory. + +1. Build the docker image. + + ```shell + docker build --tag diagrams:1.0 -f ./docker/dev/Dockerfile . + ``` + +1. Create the container, run in background and mount the project source code. + + ```shell + docker run -d \ + -it \ + --name diagrams \ + --mount type=bind,source="$(pwd)",target=/usr/src/diagrams \ + diagrams:1.0 + ``` + +1. Run unit tests in the host using the container to confirm that it's working. + + ```shell + docker exec diagrams python -m unittest tests/*.py -v + ``` + +1. Run the bash script `autogen.sh` to test. + + ```shell + docker exec diagrams ./autogen.sh + ``` + +1. If the unit tests and the bash script `autogen.sh` is working correctly, then your system is now ready for development. \ No newline at end of file diff --git a/docker/dev/Dockerfile b/docker/dev/Dockerfile index e4baeea3..f5c9b408 100644 --- a/docker/dev/Dockerfile +++ b/docker/dev/Dockerfile @@ -18,4 +18,4 @@ WORKDIR /usr/src/diagrams COPY . . # install python requirements. -RUN pip install -r ./docker/dev/requirements.txt +RUN pip install black diff --git a/docker/dev/requirements.txt b/docker/dev/requirements.txt deleted file mode 100644 index 294444f1..00000000 --- a/docker/dev/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -diagrams -black \ No newline at end of file