wagtail-longclaw/README.md

2.3 KiB

Longclaw

Call For Maintainers

If you are interested in developing this project, please get in touch https://github.com/JamesRamm/longclaw/issues/375

Pypi Version Codecov Status Build Status Code Health

An e-commerce extension for Wagtail CMS

Checkout the documentation

Image of the dashboard

Quickstart

Install Longclaw:

pip install longclaw

Setup a Longclaw project

longclaw start my_project

Go to project directory and create missing migrations

python manage.py makemigrations home catalog

Do migrations for whole project and run

python manage.py migrate
python manage.py loadcountries
python manage.py createsuperuser
python manage.py runserver

Features

  • Tightly integrated with Wagtail. Create products, manage orders, configure shipping and view statistics all from the Wagtail admin.
  • Multiple payment backends. Longclaw currently supports Stripe, Braintree and PayPal (v.zero) payments.
  • Comprehensive REST API & javascript client easily loaded via a template tag
  • Create your catalogue as Wagtail pages, with complete control over your product fields
  • Easy setup. Just run longclaw start my_project to get going
  • Simple to use, simple to change. Write your frontend as you would any other wagtail website. No complicated overriding, forking etc in order to customise behaviour.

Screenshots

Order Detail

Development setup

Work in progress!

This is a brief guide to setting up a development environment for Longclaw.

Create a virtualenv and install the requirements

python3 -m venv venv
source venv/bin/activate
pip install -e ".[testing]"

Run the tests

make test

Run the tests with TOX

make test-all