cartridge.jupo.orgGitHub - stephenmcd/cartridge: Ecommerce for Mezzanine

Navigation Menu Toggle navigation Sign in Product Actions Automate any workflow Packages Host and manage packages Security Find and fix vulnerabilities Codespaces Instant dev environments Copilot Write better code with AI Code review Manage code changes Issues Plan and track work Discussions Collaborate outside of code Explore All features Documentation GitHub Skills Blog Solutions For Enterprise Teams Startups Education By Solution CI/CD & Automation DevOps DevSecOps Resources Learning Pathways White papers, Ebooks, Webinars Customer Stories Partners Open Source GitHub Sponsors Fund open source developers The ReadME Project GitHub community articles Repositories Topics Trending Collections Pricing Search or jump to... Search code, repositories, users, issues, pull requests...Searchsyntax tips Provide feedbackWe read every piece of feedback, and take your input very seriously. Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quicklyName Query To see all available qualifiers, see our documentation . Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} stephenmcd / cartridge Public Notifications Fork 301 Star 698 Ecommerce for Mezzanine cartridge.jupo.org License BSD-2-Clause license 698 stars 301 forks Branches Tags Activity Star Notifications Code Issues 23 Pull requests 9 Actions Projects 0 Wiki Security Insights Additional navigation options Code Issues Pull requests Actions Projects Wiki Security Insights stephenmcd/cartridge This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Branches Tags Go to file Code Folders and files Name Name Last commit message Last commit date Latest commit History 1,480 Commits .github/ workflows .github/ workflows .tx .tx cartridge cartridge docs docs tests tests .gitignore .gitignore .hgignore .hgignore .hgtags .hgtags .isort.cfg .isort.cfg .releaserc .releaserc AUTHORS AUTHORS CHANGELOG CHANGELOG LICENSE LICENSE MANIFEST.in MANIFEST.in README.rst README.rst SECURITY.md SECURITY.md pyproject.toml pyproject.toml pytest.ini pytest.ini setup.cfg setup.cfg setup.py setup.py tox.ini tox.ini View all files Repository files navigation README BSD-2-Clause license Security Created by Stephen McDonald Overview Cartridge is a shopping cart application built using the Django framework. It is BSD licensed , and designed to provide a clean and simple base for developing e-commerce websites. It purposely does not include every conceivable feature of an e-commerce website; instead, Cartridge focuses on providing core features common to most e-commerce websites. This specific focus stems from the idea that every e-commerce website is different, is tailored to the particular business and products at hand, and should therefore be as easy to customize as possible. Cartridge achieves this goal with a code-base that is as simple as possible and implements only the core features of an e-commerce website. Cartridge extends the Mezzanine content management platform. A live demo of Cartridge can be found by visiting the Mezzanine live demo . Features Hierarchical categories Easily configurable product options (colours, sizes, etc.) Hooks for tax/shipping calculations and payment gateways Sale pricing Promotional discount codes PDF invoice generation (for packing slips) Stock control Product popularity Thumbnail generation Built-in test suite Separation of presentation (no embedded markup) Smart categories (by price range, colour, etc) Registered or anonymous checkout Configurable number of checkout steps Denormalised data for accessibility and performance Authenticated customer accounts with transaction history Dependencies Cartridge is designed as a plugin for the Mezzanine content management platform, and therefore requires Mezzanine to be installed. The integration of the two applications should occur automatically by following the installation instructions below. Installation The easiest method is to install directly from PyPI using pip by running the command below, which will also install the required dependencies mentioned above: $ pip install -U cartridge Otherwise, you can download Cartridge and install it directly from source: $ python setup.py install Once installed, the command mezzanine-project can be used to create a new Mezzanine project, with Cartridge installed, in similar fashion to django-admin.py : $ mezzanine-project -a cartridge project_name $ cd project_name $ python manage.py createdb noinput $ python manage.py runserver Here we specify the -a switch for the mezzanine-project command, which tells it to use an alternative package (cartridge) for the project template to use. Both Mezzanine and Cartridge contain a project template package containing the settings.py and urls.py modules for an initial project. If you’d like to add Cartridge to an existing Mezzanine or Django project, you’ll need to manually configure these yourself. See the FAQ section of the Mezzanine documentation for more information. Note The createdb command is a shortcut for using Django’s migrate command, which will also install some demo content, such as a contact form, image gallery, and more. If you’d like to omit this step, use the nodata option with createdb . You should then be able to browse to http://127.0.0.1:8000/admin/ and log in using the default account ( username: admin, password: default ). If you’d like to specify a different username and password during set up, simply exclude the noinput option included above when running createdb . Contributing Cartridge is an open source project managed using both the Git and Mercurial version control systems. These repositories are hosted on both GitHub and Bitbucket respectively, so contributing is as easy as forking the project on either of these sites and committing back your enhancements. Please note the following guidelines for contributing: Contributed code must be written in the existing style. For Python (and to a decent extent, JavaScript as well), this is as simple as following the Django coding style and (most importantly) PEP 8 . Front-end CSS should adhere to the Bootstrap CSS guidelines . Contributions must be available on a separately named branch based on the latest version of the main branch. Run the tests before committing your changes. If your changes cause the tests to break, they won’t be accepted. If you are adding new functionality, you must include basic tests and documentation. Here’s a quick start to hacking on Cartridge after forking it on GitHub, by using the internal "project_template" as your current project: $ git clone https://github.com/your-github-username/cartridge/ $ cd cartridge $ git checkout -b your-new-branch-name $ cp cartridge/project_template/project_name/local_settings.py{.template,} $ python setup.py develop $ python cartridge/project_template/manage.py createdb noinput $ python cartridge/project_template/manage.py runserver "hack hack hack" $ python setup.py test $ git commit -am "A message describing what you changed." $ git push origin your-new-branch-name Note Cartridge’s development branch often relies on features that exist in Mezzanine’s development branch, but haven’t yet made it into an official release. To install Mezzanine’s development version in your environment, run: $ pip installIf you’re certain you’ve come across a bug, then please use the GitHub issue tracker . It’s crucial that enough information is provided to reproduce the bug. This includes things such as the Python stack trace generated by error pages, as well as other aspects of the development environment used, such as operating system, database, Python version, etc. If you’re not sure...