2017-02-03 10:04:57 +00:00
|
|
|
=============================
|
|
|
|
|
Longclaw
|
|
|
|
|
=============================
|
|
|
|
|
|
|
|
|
|
.. image:: https://badge.fury.io/py/longclaw.svg
|
|
|
|
|
:target: https://badge.fury.io/py/longclaw
|
|
|
|
|
|
2017-05-24 10:12:36 +00:00
|
|
|
.. image:: https://codecov.io/gh/JamesRamm/longclaw/branch/master/graph/badge.svg
|
|
|
|
|
:target: https://codecov.io/gh/JamesRamm/longclaw
|
|
|
|
|
|
2017-02-03 10:04:57 +00:00
|
|
|
.. image:: https://travis-ci.org/JamesRamm/longclaw.svg?branch=master
|
|
|
|
|
:target: https://travis-ci.org/JamesRamm/longclaw
|
2017-02-22 16:49:37 +00:00
|
|
|
|
|
|
|
|
.. image:: https://readthedocs.org/projects/longclaw/badge/?version=latest
|
|
|
|
|
:target: http://longclaw.readthedocs.io/en/latest/?badge=latest
|
|
|
|
|
:alt: Documentation Status
|
2017-02-03 10:04:57 +00:00
|
|
|
|
2017-04-10 16:07:16 +00:00
|
|
|
An e-commerce extension for `Wagtail CMS <https://github.com/wagtail/wagtail>`_
|
2017-04-13 06:53:56 +00:00
|
|
|
Checkout the `demo site <https://github.com/JamesRamm/longclaw_demo>`_ and `documentation <http://longclaw.readthedocs.io/en/latest/>`_
|
2017-02-03 10:04:57 +00:00
|
|
|
|
2017-02-26 22:40:05 +00:00
|
|
|
.. figure:: docs/_static/images/dashboard.png
|
|
|
|
|
|
|
|
|
|
Longclaw dashboard
|
|
|
|
|
|
2017-02-03 10:04:57 +00:00
|
|
|
Quickstart
|
|
|
|
|
----------
|
2017-02-10 19:27:44 +00:00
|
|
|
Install Longclaw::
|
2017-02-03 10:04:57 +00:00
|
|
|
|
2017-04-13 06:53:56 +00:00
|
|
|
$ pip install longclaw
|
2017-02-22 16:23:39 +00:00
|
|
|
|
2017-02-22 16:50:18 +00:00
|
|
|
Setup a Wagtail+Longclaw project::
|
2017-02-03 10:04:57 +00:00
|
|
|
|
2017-03-24 10:13:30 +00:00
|
|
|
$ longclaw start my_project
|
2017-02-03 10:04:57 +00:00
|
|
|
|
|
|
|
|
Features
|
|
|
|
|
--------
|
|
|
|
|
|
2017-02-26 13:56:13 +00:00
|
|
|
View and fulfill orders from the Wagtail admin
|
|
|
|
|
+++++++++++++++++++++++++++++++++++++++++++++++
|
|
|
|
|
|
|
|
|
|
.. figure:: docs/_static/images/order_list.png
|
|
|
|
|
|
|
|
|
|
The orders list can be sorted and filtered by status, date or customer
|
|
|
|
|
|
|
|
|
|
.. figure:: docs/_static/images/order_detail.png
|
|
|
|
|
|
|
|
|
|
Variable Shipping Rates
|
|
|
|
|
+++++++++++++++++++++++
|
|
|
|
|
|
|
|
|
|
Manage your shipping destinations and rates from the Wagtail admin.
|
|
|
|
|
|
|
|
|
|
Pluggable basket and checkout API
|
|
|
|
|
++++++++++++++++++++++++++++++++++
|
|
|
|
|
|
|
|
|
|
Longclaw provides a simple RESTful API for retrieving/updating the shopping basket and for performing a checkout.
|
|
|
|
|
Longclaw currently supports Stripe, Braintree and PayPal (v.zero) payments.
|
|
|
|
|
|
|
|
|
|
Easy project startup and catalogue modelling
|
|
|
|
|
++++++++++++++++++++++++++++++++++++++++++++
|
|
|
|
|
|
|
|
|
|
Longclaw provides a project template to easily setup your Wagtail + Longclaw project. This sets up a basic ``ProductVariant`` model
|
|
|
|
|
so you can get started adding your product-specific fields straight away.
|
2017-02-03 10:04:57 +00:00
|
|
|
|
|
|
|
|
Running Tests
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
source <YOURVIRTUALENV>/bin/activate
|
|
|
|
|
(myenv) $ pip install tox
|
|
|
|
|
(myenv) $ tox
|
2017-03-31 07:07:20 +00:00
|
|
|
|
|
|
|
|
Support
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Please raise bugs/feature requests using the github issue tracker and ask questions on stackoverflow.
|
2017-02-03 10:04:57 +00:00
|
|
|
|
2017-04-13 06:53:56 +00:00
|
|
|
|
