Guide is a website to help content editors, moderators, administrators, and other users learn how to use the Wagtail content management system (CMS).
The Wagtail guide will ultimately include:
You can learn more about the documentation system here.
We assume that you have basic knowledge of Node/Webpack and Python/Django/Wagtail in these instructions. We recommend you develop Wagtail Guide locally on your machine using venv
and fnm to ensure you are on the correct Node version.
.nvmrc
for version)Run:
python -V
Confirm that the output is showing version Python 3.11 (or higher). If not, you may have multiple versions of Python installed on your system and will need to switch to the appropriate version when creating the virtual environment.
With the Python version output confirmed, install Poetry.
Now we're ready to set up the guide project:
cd ~/dev [or your preferred dev directory]
git clone https://github.com/wagtail/guide.git
cd guide
make backend
make frontend
make buildfixtures
Once the backend and frontend have been set up, you can run the development server with:
make run
If everything worked, http://127.0.0.1:8000 should show you a welcome page.
You can access the administrative area at http://127.0.0.1:8000/admin and log in using the credentials you created during the backend setup.
To activate Poetry's virtual environment, run:
poetry shell
To generate and compile translation strings, run:
make makemessages
make compilemessages
Or both, in a single command:
make translations
.env
file in the project root containing these variables, you can adjust the values to your preferences:
ALLOWED_HOSTS=localhost
PORT=8000
SECRET_KEY=some-random-secret
DJANGO_SETTINGS_MODULE=apps.guide.settings.dev
make docker-build
command.make docker-run
.make docker-init
http://localhost:8000
With Gitpod you can deploy a ready-to-code Wagtail Guide development environment with a single click to evaluate the code.
Steps:
Open in Gitpod
button./admin/
with username admin
and password changeme
If you're a Python or Django developer, fork the repo and join us. You'll find answers to many common new contributor questions in our contributing guidelines.
make format
make lint
make test
This project is one of three Wagtail projects being sponsored by Google as a part of Google Summer of Code 2022. The team for this project includes:
You can learn more about our Google Summer of Code project in Google Summer of Code: Wagtail Editor Guide, Wagtail CMS projects for Google Summer of Code 2022 or on our wiki page.