From 7fa1077b06ad9508741dd27ce2e0ef13424e6945 Mon Sep 17 00:00:00 2001 From: ni-richard Date: Thu, 5 Sep 2019 09:14:30 +0200 Subject: [PATCH] Created Setting up a development environment (markdown) --- Setting-up-a-development-environment.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 Setting-up-a-development-environment.md diff --git a/Setting-up-a-development-environment.md b/Setting-up-a-development-environment.md new file mode 100644 index 0000000..2eed58c --- /dev/null +++ b/Setting-up-a-development-environment.md @@ -0,0 +1,24 @@ +To be able to use the framework locally, you may need to install some of the packages listed below depending on your intentions. + +### Running challenges +You can run/develop TFW exercises locally with only utilizing **Docker** containers, however, if you don't prefer building everything manually, then it is advisable to use our `tfw.sh` script that requires: +* GNU coreutils +* bash +* git + +By default, your IDE will fail to autocomplete code and will complain about missing dependencies. To fix this you should install the `tfw` pip package in your dev virtualenv: +``` +SSH: +pip install git+ssh://git@github.com/avatao-content/baseimage-tutorial-framework.git +HTTPS: +pip install git+https://github.com/avatao-content/baseimage-tutorial-framework.git +``` + +### Editing the base image +If you install everything mentioned above and clone the [base image repo](https://github.com/avatao-content/baseimage-tutorial-framework), you are covered. Make sure that the repo shares the same parent folder with your challenge, so `tfw.sh` can detect it. + +### Editing the frontend +Normally, the frontend is just statically served by *nginx* in the container, but if you wish to modify it, you will need these locally: +* yarn +* Angular CLI +After that, clone [this repo](https://github.com/avatao-content/frontend-tutorial-framework), and run `yarn install` in the root directory. \ No newline at end of file