Git Product home page Git Product logo

tgbn / wagtail-pipit Goto Github PK

View Code? Open in Web Editor NEW

This project forked from frojd/wagtail-pipit

0.0 0.0 0.0 1.47 MB

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

License: MIT License

Python 52.44% HTML 3.06% Makefile 0.61% Shell 7.03% Vim Script 0.86% JavaScript 31.59% CSS 2.34% Dockerfile 0.81% Smarty 1.28%

wagtail-pipit's Introduction

CircleCI

Pipit

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

The benefit of using Pipit is that we can cherry-pick the best JavaScript tools and have a modern frontend stack while still not making the trade-off normally would by running our application completely headless.

Features

  • Hot reloading
  • Server-Side Rendering
  • 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
  • Data-sync between environments

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
  1. 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:

Why not headless?

The current state of Django in combination with JavaScript frontend technologies is to either go for a headless solution where Django is only used as an admin and data-provider via API, or a hybrid approach where the most parts of the site are classic Django in Django Template Language and complex frontend components are built in React (or another frontend framework).

The cost of going for the headless approach is that you lose basically everything that Django provides for HTTP-requests. Including session management, CSRF, security middlewares, routing, previews, etc.

The problem we have encountered with the hybrid approach is that as your project grows, it gets really hard to keep track of where your views are declared. Is it in the JavaScript or in Django Template Language? Also, the way React is designed makes it really hard to share state between different React-instances and you have to rely on technologies such as Redux.

Contribute

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

Support

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

wagtail-pipit's People

Contributors

marteinn avatar rinti avatar martinjobb avatar mikaelengstrom avatar dependabot-preview[bot] avatar stasilo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.