Contributions#
We welcome contributions to the plantit
codebase, from bug reports to documentation fixes to pull requests of all kinds! All development planning is carried out on GitHub: see the Changelog/Roadmap and Issues in particular.
Configuring a development environment#
See the README for instructions on installing the project from source.
Command cheatsheet#
Below is a list of handy commands for managing the plantit
application.
Docker Compose#
docker-compose -f docker-compose.dev.yml up
: bring the full application (all containers) updocker-compose -f docker-compose.dev.yml down
: bring the full application (all containers) downdocker-compose -f docker-compose.dev.yml run plantit <command>
run a command in theplantit
container (starting containers as needed)docker-compose -f docker-compose.dev.yml exec plantit <command>
run a command in theplantit
container (assumes all containers are up)
Docker#
docker ps
: list running containersdocker exec -it <container ID> bash
: enter an already running container
Django#
./manage.py
: list Django commands./manage.py makemigrations
: create plan for django migrations./manage.py migrate
: run django migrations./manage.py shell
: opens Django Python interpreter