From 5f3476b655ac0d7b93ab6128c557b167a0cf4272 Mon Sep 17 00:00:00 2001 From: Frank Wiles Date: Thu, 26 May 2022 08:29:35 -0500 Subject: [PATCH] Update README --- README.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index b4a8a485..a07c9a15 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ -# Forum +# Boost.org Website ## Overview -A Django project starter kit +A Django based website that will power https://boost.org ## Local Development Setup -This project will use Python 3.8, Docker, and Docker Compose. +This project will use Python 3.9, Docker, and Docker Compose. -Make a Python 3.8.x virtualenv. +**NOTE**: All of these various docker-compose commands, along with other helpful +developer utility commands, are codified in our `justfile` and can be ran with +less typing. Copy .env-dist to .env and adjust values to match your local environment: @@ -19,15 +21,9 @@ $ cp env.template .env Then run: ```shell -# rebuild our services -$ docker-compose build - -# start our services +# start our services (and build them if necessary) $ docker-compose up -# start our services with daemon mode -$ docker-compose up -d - # to create a superuser $ docker-compose run --rm web python manage.py createsuperuser @@ -42,7 +38,7 @@ This will create the Docker image, install dependencies, start the services defi ### Cleaning up -To shut down our database and any long running services, we shut everyone down using: +To shut down our database and any long running services, we shut everyone down using: ```shell $ docker-compose down @@ -53,15 +49,9 @@ $ docker-compose down Forum ships with Celery and Redis support, but they are off by default. To rebuild our image with support, we need to pass the `docker-compose-with-celery.yml` config to Docker Compose via: ```shell -# rebuild our services -$ docker-compose -f docker-compose-with-celery.yml build - # start our services $ docker-compose -f docker-compose-with-celery.yml up -# start our services with daemon mode -$ docker-compose -f docker-compose-with-celery.yml up -d - # stop and unregister all of our services $ docker-compose -f docker-compose-with-celery.yml down ``` @@ -74,6 +64,12 @@ To run the tests, execute: $ docker-compose run --rm web pytest ``` +or run: + +```shell +$ just test +``` + ## Deploying TDB