The project uses Docker for local development. The Wagtail project is in the app directory. The project is set up to use a SQLite database by default.
It's recommended to use the same database in development as you will use in production.
If you added any data to the SQLite database you will need to add it again to the new database if you change it here. It's therefore a good idea to choose your database before you start adding data/content to the project.
The process to change the database is simple and is outlined below, essentially you need to comment out the database you are not using and uncomment the one you are using in the Makefile and rebuild the Docker containers.
Open the Makefile (at the root of your project) and comment out the line:
DC = docker compose -f compose.yaml -f compose.sqlite3.override.yaml # SQLITE Databaseand uncomment the line:
DC = docker compose -f compose.yaml -f compose.mysql.override.yaml # MySQL DatabaseThis will run a MySQL database as a service in the Docker container and use it as the database for the project.
Open the Makefile (at the root of your project) and comment out the line:
DC = docker compose -f compose.yaml -f compose.sqlite3.override.yaml # SQLITE Databaseand uncomment the line:
DC = docker compose -f compose.yaml -f compose.postgresql.override.yaml # PostgreSQL DatabaseThis will run a Postgres database as a service in the Docker container and use it as the database for the project.
The database settings are already set as environment variables in the docker-compose files so no further configuration is required.
You will need to run though the initial setup steps again including applying migrations and creating a superuser
The project includes a styleguide page at http://localhost:8000/style-guide/ which demonstrates the Pico CSS classless styling and includes some common HTML elements.
The styleguide is available only in debug mode.