README 2.md

Wagtial website

Code for site at: http://wagtial.maptitud.xyz

@rhysallister

Getting started

Make sure Python 3.10 or higher is installed on your system. Open this directory in a command prompt, then:

1. Install the software, and the dev tooling:

   pip install -r requirements.txt -r requirements-dev.txt
   

2. Build the Sass:

   python manage.py sass -g website/static/website/src/custom.scss website/static/website/css/
   

   To build the Sass automatically whenever you change a file, add the --watch option and run it in a separate terminal. To build a compressed/minified production version, add the -t compressed option. For more options, see django-sass.

3. Run the development server:

   python manage.py runserver
   

4. Go to http://localhost:8000/ in your browser, or http://localhost:8000/admin/ to log in and get to work!

Linting / pre-deployment

To check for errors, run the following commands:

ruff check --fix .
ruff format .
mypy .
pytest .

Before deploying, be sure to build the sass:

python manage.py sass -t compressed website/static/website/src/custom.scss website/static/website/css/

Documentation links

• To customize the content, design, and features of the site see Wagtail CRX.

• For deeper customization of backend code see Wagtail and Django.

• For HTML template design see Bootstrap.

---

Made with ♥ using Wagtail + CodeRed Extensions