Metadata-Version: 2.4
Name: shopcube
Version: 5.0.0
Summary: E-commerce solution
Author-email: Abdur-Rahmaan Janhangeer & contributors <arj.python@gmail.com>
License: MIT
Project-URL: Bug Reports, https://github.com/Abdur-RahmaanJ/shopcube/issues
Project-URL: Source, https://github.com/Abdur-RahmaanJ/shopcube/
Keywords: flask,pos,management,shop,ecommerce,cms,erp,e-commerce
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: alembic==1.7.3
Requires-Dist: click==8.0.1
Requires-Dist: dnspython==2.1.0
Requires-Dist: email-validator==1.1.3
Requires-Dist: et-xmlfile==1.1.0
Requires-Dist: flask==2.2.0
Requires-Dist: flask-admin==1.6.0
Requires-Dist: flask-login==0.6.2
Requires-Dist: flask-mailman==0.3.0
Requires-Dist: flask-marshmallow==1.0.0
Requires-Dist: flask-migrate==3.1.0
Requires-Dist: flask-reuploaded==1.2.0
Requires-Dist: flask-sqlalchemy==2.5.1
Requires-Dist: flask-wtf==1.0.0
Requires-Dist: greenlet==3.1.1
Requires-Dist: idna==2.10
Requires-Dist: itsdangerous==2.0.1
Requires-Dist: jinja2==3.0.1
Requires-Dist: mako==1.1.5
Requires-Dist: markupsafe==2.1.1
Requires-Dist: marshmallow==3.14.1
Requires-Dist: marshmallow-sqlalchemy==0.26.1
Requires-Dist: mkdocs-material-extensions==1.0.3
Requires-Dist: numpy==2.1.1
Requires-Dist: openpyxl==3.0.10
Requires-Dist: packaging==24.1
Requires-Dist: pandas==2.2.2
Requires-Dist: pillow==10.4.0
Requires-Dist: pymysql==1.0.2
Requires-Dist: python-dateutil==2.8.2
Requires-Dist: pytz==2022.2.1
Requires-Dist: shopyo==4.13.1
Requires-Dist: six==1.16.0
Requires-Dist: sqlalchemy==1.4.46
Requires-Dist: tzdata==2024.1
Requires-Dist: werkzeug==2.2.2
Requires-Dist: wtforms==3.0.1
Requires-Dist: setuptools
Dynamic: license-file

<div align="center">



<img src="https://github.com/Abdur-rahmaanJ/shopcube/raw/dev/assets/logo.png" width="250" />

[![First Timers Only](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://www.firsttimersonly.com/)

🇲🇺 🇵🇰 🇳🇬 🇮🇳 🇻🇳 🇬🇭 🇬🇧

</div>

<div align="center">

[![Discord](https://img.shields.io/badge/chat%20on-discord-green.svg)](https://discord.gg/k37Ef6w)
[![CodeQL](https://github.com/shopyo/shopcube/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shopyo/shopcube/actions/workflows/codeql-analysis.yml)

</div>

# shopcube

shopcube is an e-commerce solution for shops. Complete with

- cart
- wishlist
- orders
- upload by csv
- charts
- theming

If you want to contribute, go ahead, we welcome it. We follow a 100% first-timers-friendly policy. Join #shopcube on Discord if you get stuck or would just like to chat and say hi.

Powered by Shopyo, a Python web framework built on top of Flask.

## Quick Start

### Installation

Clone the repository and set up a virtual environment:

```bash
git clone https://github.com/shopyo/shopcube.git
cd shopcube
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip setuptools
pip install -e .
```

### Initialisation

To set up the database and default settings without clearing existing migrations:

```bash
cd src/shopcube
shopyo initialise --no-clear-migration
```

### Running the Application

To run the development server:

```bash
flask run
```

Access the application at http://127.0.0.1:5000

Login as administrator:
- Email: admin@domain.com
- Password: pass

The dashboard is available at http://127.0.0.1:5000/dashboard/

## Deployment

For production deployment, use a WSGI server like Gunicorn.

### Example with Gunicorn

```bash
gunicorn --bind 0.0.0.0:8000 wsgi:application
```

Ensure you have a `config.json` in your execution directory. You can copy the demo config:

```bash
cp src/shopcube/config_demo.json config.json
```

## Development

### Running Tests

```bash
cd src/shopcube
python -m pytest
```

### Useful Commands

```bash
flask flight-info
```
