Getting Started with FraiseQL¶
Welcome! This directory contains everything you need to go from zero to building your first FraiseQL application.
Learning Path¶
Follow this recommended progression:
1. Quickstart (5 minutes) 🚀¶
Get a working GraphQL API running immediately.
You'll build: A simple note-taking API with queries and mutations
You'll learn:
- Installing FraiseQL
- Creating database views
- Defining GraphQL types
- Writing queries and mutations
Start here if: You want to see FraiseQL in action right now
2. First Hour Guide (60 minutes) 📚¶
Progressive tutorial building on the quickstart.
You'll build: Extended note-taking API with filtering, timestamps, and error handling
You'll learn:
- Adding fields and filtering
- Where input types and operators
- Mutation error handling patterns
- Production patterns (timestamps, triggers)
Start here if: You completed the quickstart and want to go deeper
3. Installation Guide 🔧¶
Platform-specific installation instructions and troubleshooting.
You'll learn:
- Python environment setup
- PostgreSQL installation by OS
- Dependency management
- Common installation issues
Start here if: You're having installation problems
After Getting Started¶
Once you've completed these guides, continue your learning journey:
Understanding the Architecture¶
- Understanding FraiseQL - 10-minute architecture deep dive
- Core Concepts - CQRS, JSONB views, Trinity identifiers
Building Real Applications¶
- Blog API Tutorial - Complete application example
- Beginner Learning Path - Structured skill progression
When Things Go Wrong¶
- Troubleshooting Guide - Common issues and solutions
- Troubleshooting Decision Tree - Diagnostic flowchart
Quick Reference¶
Prerequisites: Python 3.13+, PostgreSQL 13+
Installation: pip install "fraiseql<2"
Documentation Hub: Documentation Home
Need help?: GitHub Discussions
Ready to start? → Open the Quickstart Guide