tAPIstry
Back to docs index

Getting Started

This developer-focused checklist gets the Tapistry stack running locally. Once your environment is ready, follow the role-specific quickstarts to either publish an API or consume one from the marketplace.

Prerequisites

  • Node.js 18+ with pnpm
  • Python 3.9+ with pip
  • Docker and Docker Compose
  • Git with SSH keys configured
  • VS Code (recommended) or your preferred editor

Clone the repository

Grab the source and install shared dependencies:

git clone https://github.com/sgreysond/tapistry_platform.git
cd tapistry_platform
make install

Configure environments

Copy the environment templates and update secrets as needed:

cp apps/backend/.env.example apps/backend/.env
cp apps/frontend/.env.example apps/frontend/.env

# Required backend values
DATABASE_URL=sqlite:///./dev.db
REDIS_URL=redis://localhost:6379
JWT_SECRET=replace-me
FERNET_KEY=generate-with-python-cryptography-fernet
STRIPE_SECRET_KEY=sk_test_replace_me
ENVIRONMENT=development

# Required frontend values
NEXT_PUBLIC_BACKEND_URL=http://127.0.0.1:8000
NEXT_PUBLIC_INVOKE_BASE_URL=http://127.0.0.1:8000
NEXT_PUBLIC_ENVIRONMENT=development

Seed demo data (optional)

Populate the marketplace with sample APIs to explore pricing and invocation flows:

python scripts/ops/seed_marketplace.py --backend http://localhost:8000 --count 3

Start local services

Run the full stack or individual pieces while you build:

make dev          # all core services
make dev-backend  # backend API on :8000
make dev-frontend # marketing + app shell on :3000

Run migrations

Apply the latest database schema and create a test user:

cd apps/backend
alembic upgrade head
python scripts/create_test_user.py

Next steps

  • Creators: jump into the Creator Quickstart after running tapi login.
  • Consumers: review the Consumer Quickstart to browse APIs and mint keys.
  • Browse additional guides from the docs index for security, troubleshooting, and architecture deep dives.