Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 3.75 KB

README.md

File metadata and controls

90 lines (65 loc) · 3.75 KB

Ship Python Example

api-first-architecture docker electron fastapi javascript multi-platform-development pwa python react typescript

A complete working example of a multi-platform Python application demonstrating the architecture from Ship Python, Orchestrate AI: Professional Python in the AI Era by Michael Borck.

This example shows a simple task manager application with:

  • FastAPI backend with RESTful API
  • React frontend with TypeScript
  • Electron desktop wrapper
  • Docker deployment configuration

Running the Example

Backend

cd backend
uv sync
uv run uvicorn my_app.main:app --reload

Visit http://localhost:8000/docs to see the API documentation.

Frontend

cd frontend
npm install
npm run dev

Visit http://localhost:5173 to see the app.

Docker (Full Stack)

docker-compose -f docker/docker-compose.yml up

Desktop (Electron)

cd frontend && npm run build
cd ../electron
npm install
npm start

What This Example Demonstrates

  1. API-First Architecture: Backend and frontend communicate through a well-defined REST API
  2. Type Safety: Pydantic models (backend) and TypeScript (frontend) ensure type safety
  3. Modern Tooling: uv, Vite, React Query for efficient development
  4. Multi-Platform Distribution: Same codebase runs as web app, PWA, and desktop app
  5. AI-Ready Structure: CLAUDE.md provides context for AI assistants

Project Structure

ship-python-example/
├── backend/           # FastAPI backend
│   ├── src/my_app/    # Application code
│   └── tests/         # API tests
├── frontend/          # React frontend
│   └── src/           # Components and services
├── electron/          # Desktop wrapper
├── docker/            # Container configs
├── .github/workflows/ # CI/CD
└── CLAUDE.md          # AI context

Using This as a Starting Point

If you want to use this architecture for your own project:

  1. Cookiecutter template: cookiecutter gh:michael-borck/ship-python-cookiecutter - Full customization
  2. GitHub template: ship-python-template - Quick start

Related Resources

License

MIT License - see LICENSE for details.