Skip to content

Commit

Permalink
Add docs for using just when developing locally with docker
Browse files Browse the repository at this point in the history
  • Loading branch information
earthcomfy committed Jan 5, 2025
1 parent 488995e commit 3af5305
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/2-local-development/developing-locally-docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,31 @@ The stack comes with a dedicated node service to build the static assets, watch
.. _Sass: https://sass-lang.com/
.. _live reloading: https://browsersync.io


Using Just for Docker Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We have included a ``justfile`` to simplify the use of frequent Docker commands for local development. Here are the available commands:

- ``just build``
Builds the Python image using the local Docker Compose file.

- ``just up``
Starts the containers in detached mode and removes orphaned containers.

- ``just down``
Stops the running containers.

- ``just prune``
Stops and removes containers along with their volumes. You can optionally pass an argument with the service name to prune a single container.

- ``just logs``
Shows container logs. You can optionally pass an argument with the service name to view logs for a specific service.

- ``just manage <command>``
Runs Django management commands within the container. Replace ``<command>`` with any valid Django management command, such as ``migrate``, ``createsuperuser``, or ``shell``.


(Optionally) Developing locally with HTTPS
------------------------------------------

Expand Down

0 comments on commit 3af5305

Please sign in to comment.