Quickstart

Get a production-ready Flask app running in under 10 minutes.

—

Install Shopyo

pip install shopyo

Create Your Project

# Create a new project folder with a flat structure
shopyo new myproject
cd myproject
shopyo initialise   # Sets up DB and migrations
flask run --debug   # Start server

Access Your App

Open http://localhost:5000 in your browser.

Create Your First Module

# Interactive mode
shopyo startapp -i

# Or specify directly
shopyo startapp blog

This creates:

modules/
└── blog/
    ├── __init__.py
    ├── forms.py
    ├── global.py
    ├── models.py
    ├── view.py
    ├── info.json
    ├── tests/
    │   ├── test_blog_functional.py
    │   └── test_blog_models.py
    ├── static/
    └── templates/
        └── blog/
            ├── blocks/
            │   └── sidebar.html
            ├── dashboard.html
            └── index.html

Run Initialise to Register Module

shopyo initialise

Your module is now live at http://localhost:5000/blog/

What’s Next?