# Project Layout

URL: /docs/get-started/project-layout/
Section: get-started
Tags: getting-started, layout, structure, conventions

--------------------------------------------------------------------------------

Recommended Structure Chirp does not enforce a specific layout. This is the convention used by chirp new: myapp/ app.py # App instance, middleware, auth routes, entry point models.py # User model + password verification helpers pages/ _layout.html # Shared page layout page.py # Home route handler page.html # Home template login/ page.py # Login page handler page.html # Login template dashboard/ page.py # Protected dashboard handler page.html # Dashboard template static/ style.css # CSS, JS, images tests/ conftest.py # Test import setup test_app.py # Auth flow + smoke tests Key Directories Directory Purpose app.py App creation, middleware setup, auth routes, if __name__ == "__main__": app.run() models.py User model and credential verification helpers for scaffolded auth pages/ Filesystem routes. Paths are relative to AppConfig(template_dir="pages"). static/ CSS, JS, images. Served at /static by default. tests/ Pytest tests. Use TestClient(app) for requests. Optional Layouts Minimal (chirp new myapp --minimal): myapp/ app.py templates/ index.html With SSE (chirp new myapp --sse): Adds EventStream route, boost layout, and sse-connect in the template. Customizing Template directory: AppConfig(template_dir="pages") Static directory: AppConfig(static_dir="assets") Component libraries: AppConfig(component_dirs=("components",)) for shared partials Next Steps Installation — Install Chirp Quickstart — Build your first app

--------------------------------------------------------------------------------

Metadata:
- Word Count: 191
- Reading Time: 1 minutes