boost/website-v2
2
0
Fork 0
mirror of https://github.com/boostorg/website-v2.git synced 2026-01-19 04:42:17 +00:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Frank Wiles
2022-05-26 08:29:35 -05:00
parent 547c45e02a
commit 5f3476b655
1 changed files with 14 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -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