mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2024-11-15 10:07:17 +00:00
Code Issues Releases Wiki Activity

Created Setting up a development environment (markdown)

ni-richard 2019-09-05 09:14:30 +02:00
parent b088d54c93
commit 7fa1077b06
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Setting-up-a-development-environment.md Normal file

@ -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.