Getting Started

Prerequisites

• Python 3.12+
• MongoDB (local or cloud)
• Node.js 20+ (for admin app)

Quick Start

1. Create a new API project

pip install cookiecutter
cookiecutter gh:easy-software-system/craft-easy-template --directory=api

2. Install dependencies

cd your-project
python3.12 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

3. Run the API

MONGODB_URI="mongodb://localhost:27017/?directConnection=true" \
DATABASE_NAME="my-project" \
ENVIRONMENT="development" \
AUTH_ENABLED="false" \
uvicorn your_project.app:app --factory --port 5001

4. Verify

curl http://localhost:5001/health

API docs available at http://localhost:5001/docs

Next Steps

• Read the API Specification for the full framework reference
• Set up the Admin App for a visual interface
• Explore Enterprise Features for multi-tenant, GDPR, and payments