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

Reorder and augment stuff in readme

Browse Source
This commit is contained in:
Kristóf Tóth 2018-06-08 12:00:30 +02:00
parent a6e8f4b898
commit 164c044595
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -20,18 +20,6 @@ Getting started with creating challenges using the framework – *setting up a d
## Setting up a development environment ## Setting up a development environment
Just copy and paste the following command in a terminal:
`bash -c "$(curl -fsSL https://git.io/vxBfj)"`
Note that your SSH public key must be added to your GitHub user for this to work, or you mush select HTTPS remotes when prompted.
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:
- `pip install git+ssh://git@github.com/avatao-content/baseimage-tutorial-framework.git` (SSH)
- `pip install git+https://github.com/avatao-content/baseimage-tutorial-framework.git` (HTTPS)
Dependencies: Dependencies:
- bash - bash
- git - git
@ -40,13 +28,24 @@ Dependencies:
- Angular CLI - Angular CLI
- GNU coreutils - GNU coreutils
> You have trust issues regarding the public key infrastructure? You can request a checksum authenticated version of the installer command from our team! Just copy and paste the following command in a terminal:
`bash -c "$(curl -fsSL https://git.io/vxBfj)"`
Please do not hesitate to contact us with error logs included should this command fail to complete.
Note that your SSH public key must be added to your GitHub user for this to work, or you mush select HTTPS remotes when prompted.
This will set up a dev environment based on [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) just for you: This will set up a dev environment based on [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) just for you:
- it builds the latest release of the framework Docker baseimage locally - it builds the latest release of the framework Docker baseimage locally
- it pins `solvable/Dockerfile` to use the this image - it pins `solvable/Dockerfile` to use the this image
- it includes the latest frontend in `solvable/frontend` with dependencies installed - it includes the latest frontend in `solvable/frontend` with dependencies installed
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:
- `pip install git+ssh://git@github.com/avatao-content/baseimage-tutorial-framework.git` (SSH)
- `pip install git+https://github.com/avatao-content/baseimage-tutorial-framework.git` (HTTPS)
## Building & running ## Building & running
### Automated ### Automated