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

Updated Setting up a development environment (markdown)

ni-richard 2019-09-09 08:56:30 +02:00
parent ac6c42fd4c
commit 2961feb349
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Setting-up-a-development-environment.md

@ -1,7 +1,7 @@
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:
You can run/develop TFW exercises locally with only utilizing **Docker** containers, however, if you don't prefer [building everything manually](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/Building-everything-manually), then it is advisable to use our `tfw.sh` script that requires:
* GNU coreutils
* bash
* git
@ -15,10 +15,10 @@ pip install git+https://github.com/avatao-content/baseimage-tutorial-framework.g
```
### 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.
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.
After that, clone this [repo](https://github.com/avatao-content/frontend-tutorial-framework), and run `yarn install` in the root directory.