Pipit

Pipit is a Wagtail CMS boilerplate which aims to provide an easy and modern developer workflow with a React-rendered frontend.

Features

• Hybrid static and server rendered React using Next.js
• Page scaffolding
• 12-Factor App compliant
• Docker development environment
• Deploy scripts via Ansistrano
• Orchestration using Ansible
• Local SSL for development
• Error reporting with Sentry
• CI integration via Circle CI with Slack notifications
• Data-sync between environments
• Storybook for rapid component development

Installation

1. Make sure you have cookiecutter installed. If not run pip install cookiecutter (or via brew)

2. Run cookiecutter:

   cookiecutter https://github.com/Frojd/Wagtail-Pipit.git

3. Fill in the questions and you are done!

Documentation – Where to go from here?

We recommend you to start by checking out the Getting Started Guide. Otherwise, you can read up any of the following topics:

• Frontend Developer Guide
• Backend Developer Guide
• Provision and configure a webserver for hosting
• Setting up deployment on CircleCI
• Adding Slack notifications to CircleCI
• Sync data between environments
• Running python locally
• Using static site generation
• Working with Wagtail's routable pages
• Serving custom content type data through Next.js
• Adding multi language support
• Adding wagtail-2fa support
• Adding Sentry
• Handling CSRF Tokens
• Publish storybook
• Scaffolding

Contribute

If you have ideas for improvement, please share your thoughts through an issue. We also welcome PR's

• Issue Tracker: https://github.com/Frojd/Wagtail-Pipit/issues
• Source Code: https://github.com/Frojd/Wagtail-Pipit
• Discussions: You can find us on the Wagtail slack under the channel #pipit

Security

If you believe you have found a security issue with any of our projects please email us at security@frojd.se.

Support

If you have any issues, please submit an issue and we will do our best to help you out.