Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/longclawshop/longclaw
A shop for Wagtail CMS
https://github.com/longclawshop/longclaw
django e-commerce python python-2 python3 shop wagtail wagtail-cms
Last synced: 9 days ago
JSON representation
A shop for Wagtail CMS
- Host: GitHub
- URL: https://github.com/longclawshop/longclaw
- Owner: longclawshop
- License: mit
- Created: 2017-02-03T10:05:38.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-13T08:17:47.000Z (about 1 year ago)
- Last Synced: 2024-05-21T13:50:54.100Z (6 months ago)
- Topics: django, e-commerce, python, python-2, python3, shop, wagtail, wagtail-cms
- Language: Python
- Size: 1.86 MB
- Stars: 385
- Watchers: 24
- Forks: 83
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
- awesome-wagtail - longclaw - A shop template for Wagtail CMS. (Apps / E-commerce)
- awesome-starred - longclawshop/longclaw - A shop for Wagtail CMS (wagtail)
README
# Longclaw
## Call For Maintainers
If you are interested in developing this project, please get in touch
https://github.com/JamesRamm/longclaw/issues/375
[](https://badge.fury.io/py/longclaw)
[](https://codecov.io/gh/JamesRamm/longclaw)
[](https://travis-ci.org/JamesRamm/longclaw)
[](https://landscape.io/github/JamesRamm/longclaw/master)
An e-commerce extension for [Wagtail CMS](https://github.com/wagtail/wagtail)
Checkout the [documentation](https://longclawshop.github.io/longclaw/)
## Project Status
We are working to upgrade the package for the latest versions of Django and Wagtail. While doing this we may need to change the way the package is structured as well as making breaking changes to the code. If you want to use Longclaw in a project, please use the latest release (1.0.2) until we have finished the upgrade.
### Currently supported versions
We are currently running the tests against the following versions of Python, Django and Wagtail.
- Django >= 2.2, < 3.1
- Wagtail >= 2.11, < 2.14
- Python >= 3.7, < 3.10
### Developers
If you are interested in working on this project, please use the [Development setup](#development-setup) instructions below to get started.
## Quickstart
Install Longclaw:
```bash
pip install longclaw
```
Setup a Longclaw project
```bash
longclaw start my_project
```
Go to project directory and create missing migrations
```bash
python manage.py makemigrations home catalog
```
Do migrations for whole project and run
```bash
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
## Development setup
### Work in progress
The following instructions are for setting up a development environment for Longclaw while we work on the upgrade. If you want to use Longclaw in a project, please use the latest release (1.0.2) until we have finished the upgrade.
#### Create a virtualenv and install the requirements
```bash
python3 -m venv venv
source venv/bin/activate
pip install -e ".[testing]"
```
#### Install and build the frontend
The frontend is built using node and webpack. The version of node required is v12 (LTS). We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage node versions.
```bash
cd longclaw/client
```
Optional: If you are using nvm, you can run `nvm use` to set the correct version of node.
Install the dependencies and build the frontend
```bash
npm install --no-save
npm run build
```
#### Run the tests
```bash
make test
```
#### Run the tests with TOX
```bash
make test-all
```