Getting Started¶
This page intends to be a quick-start guide for Chirripo.
In order to start using it, the first step is to add the package to your project:
1 |
|
Then, you need to copy and edit the variables file:
1 |
|
Edit the file according to your needs. Please remember to change at least the following variables:
PROJECT_NAME
: so that it doesn't conflict with any other project using ChirripoPROJECT_ROOT
: so that the mount volumes to the container work as expectedPROJECT_DOCROOT
: actual docroot within your project (e.g. web or docroot)PORT_PREFIX
: there should be a different PORT_PREFIX for any project using Chirripo
Then, you can start the containers:
1 |
|
And finally enjoy your development environment!
Please refer to the Commands documentation to know about all the available commands.