isabella232 / shuup

E-Commerce Platform

Shuup

Shuup is an Open Source E-Commerce Platform based on Django and Python.

https://shuup.com/

Copyright

Copyright (C) 2012-2016 by Shoop Commerce Ltd. <[email protected]>

Shuup is International Registered Trademark & Property of Shoop Commerce Ltd., Business ID: FI24815722, Business Address: Aurakatu 12 B, 20100 Turku, Finland.

CLA

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.

License

Shuup is published under the GNU Affero General Public License, version 3 (AGPLv3). See the LICENSE file distributed with Shuup.

Some external libraries and contributions bundled with Shuup may be published under other AGPLv3-compatible licenses. For these, please refer to VENDOR-LICENSES.md file in the source code tree or the licenses included within each package.

Chat

We have a Gitter chat room for Shuup. Come chat with us!

Getting Started with Shuup development

See Getting Started with Shuup Development.

Contributing to Shuup

Interested in contributing to Shuup? Please see our Contribution Guide.

Documentation

Shuup documentation is available online at Read the Docs.

Documentation is built with Sphinx.

Issue the following commands to build the documentation:

pip install Sphinx  # to install Sphinx
cd doc && make html

To update the API documentation rst files, e.g. after adding new modules, use command:

./generate_apidoc.py