Shuup is an Open Source E-Commerce Platform based on Django and Python.
Copyright (c) 2012-2021 by Shuup Commerce Inc. <[email protected]>
Shuup is International Registered Trademark & Property of Shuup Commerce Inc., Business ID: BC1126729, Business Address: 1500 West Georgia Suite 1300, Vancouver, BC, V6G-2Z6, Canada.
Contributor License Agreement is required for any contribution to this project. Agreement is signed as a part of pull request process. See the CLA.rst file distributed with Shuup.
Shuup is published under Open Software License version 3.0 (OSL-3.0). See the LICENSE file distributed with Shuup.
Some external libraries and contributions bundled with Shuup may be published under other compatible licenses. For these, please refer to VENDOR-LICENSES.md file in the source code tree or the licenses included within each package.
We have a Gitter chat room for Shuup. Come chat with us!
Fastest way to get Shuup up and running is to use Docker.
Run:
docker-compose up
Open localhost:8000/sa in a browser,
log in with username: admin
password: admin
See Getting Started.
For simple project example see our Django-project template.
See Getting Started with Shuup Development.
Interested in contributing to Shuup? Please see our Contribution Guide.
Shuup documentation is available online at Read the Docs.
Documentation is built with Sphinx.
Issue the following commands to build the documentation:
pip install -r requirements-doc.txt
cd doc && make html
To update the API documentation rst files, e.g. after adding new modules, use command:
./generate_apidoc.py