README.md

SNEK - Offical Wagtail Template

This is the official template repository for Wagtail projects of SNEK.

Report bug · Request feature · Documentation

Table of contents

• Table of contents
• Quick start
• Setup with Docker
  • Dependencies
  • Installation
  • Debugging
• Setup with Python Virtual Environment
  • Dependencies
  • Installation
• Bugs and feature requests
• Contributing
• Versioning
• Creators
• Thanks
• Copyright and license

Quick start

Several quick start options are available:

• Docker
• Python Virtual Environment

Setup with Docker

Dependencies

• Docker
• Docker Compose

Installation

Run the following commands:

git clone https://github.com/snek-at/wagtail-template.git
cd Wagtail-Template
docker-compose up --build -d
docker-compose up

The demo site will now be accessible at http://localhost:8000/.

Important: This docker-compose.yml is configured for local testing only, and is not intended for production use.

Debugging

To tail the logs from the Docker containers in realtime, run:

docker-compose logs -f

Setup with Python Virtual Environment

You can start a Wagtail project from this template without setting up Docker and simply use a virtual environment, which is the recommended installation approach for all Python projects itself.

Dependencies

• Python 3.5, 3.6 or 3.7

Installation

With PIP installed, run:

git clone https://github.com/snek-at/wagtail-template.git
cd Wagtail-Template
python --version
python -m pip --version

Confirm that this is showing a compatible version of Python 3.x. If not, and you have multiple versions of Python installed on your system, you may need to specify the appropriate version when creating the venv:

python3 -m venv /path/to/new/virtual/environment

Once a virtual environment has been created, it can be “activated” using a script in the virtual environment’s binary directory. The invocation of the script is platform-specific ( must be replaced by the path of the directory containing the virtual environment):

Platform	Shell	Command to activate virtual environment
Posix	bash/zsh	$ source /bin/activate
	fish	$ . /bin/activate.fish
	csh/tcsh	$ source /bin/activate.csh
Windows	cmd.exe	C:> \Scripts\activate.bat
	PowerShell	PS C:> \Scripts\Activate.ps1

Now we're ready to set up the project itself:

pip install -r requirements/base.txt

To set up your database and load initial data, run the following commands:

./manage.py migrate
./manage.py runserver

Bugs and feature requests

Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

All code should conform to the Code Guide, maintained by SNEK.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, this repository is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

Creators

Florian Kleber	Nico Schett

Thanks

We do not have any external contributors yet, but if you want your name to be here, feel free to contribute to our project.

Copyright and license

SPDX-License-Identifier: (EUPL-1.2) Copyright © 2019-2020 Simon Prast