Finch

Showing 25 of 35 from the live probe.

• Finch Documentation

  Welcome to the Finch Documentation! This documentation will walk you through the steps to use Finch, a powerful web framework for Dart. Whether you're...

• Installation

  Finch is a server-side web framework for Dart. This page covers the prerequisites and steps to install it.

• Finch CLI

  The finch command-line tool handles everything outside a running app: scaffolding a new project, installing dependencies, running the dev server, comp...

• Configuration

  All Finch configuration lives in a FinchConfigs instance that you create once and pass to FinchApp. This page documents every option and its environme...

• Running a Finch Application

  A Finch application needs two files: app.dart (application setup) and an entry point — typically bin/main.dart for production or lib/serve.dart for de...

• Finch Configuration in pubspec.yaml

  The finch section in pubspec.yaml provides project settings to the Finch CLI. Commands such as finch run, finch serve, finch build, finch migrate --cr...

• Routing

  Routes in Finch are defined using FinchRoute objects collected inside a routing function. The routing function is registered with app.addRouting() and...

• Controllers

  A controller is a Dart class that extends Controller and groups related request handlers. Each handler method returns Future<String> — the HTTP ...

• Auth Controller

  AuthController is an abstract class that extends Controller. It provides the authentication and authorization contract for protecting routes. You impl...

• Middleware

  Middleware provides a mechanism for inspecting and filtering HTTP requests before they reach your route handler.

• Route Cache

  Caching stores HTTP responses and replays them for subsequent matching requests, skipping the controller and database entirely. This drastically reduc...

• HTTP Requests

  The Request object (rq) is available inside every Controller method and every app.get/post callback. It provides access to the full HTTP request and a...

• Templates

  Finch uses the Jinja Dart package as its template engine. Templates live in the directory configured by FinchConfigs.widgetsPath and use the extension...

• Built-in Template Events

  Finch injects a set of built-in variables and helper functions into every Jinja template. These are accessible via special prefixes alongside your own...

• Localization (i18n)

  Finch has a built-in i18n system supporting multiple languages. Language strings can be stored in JSON files or defined directly in Dart.

• Cookies and Sessions

  Finch provides two mechanisms for persisting data between HTTP requests: cookies (client-side) and sessions (server-side). Understanding the differenc...

• Advanced Forms

  AdvancedForm is Finch's built-in form validation and rendering system. It ties field definitions, validators, CSRF protection, and template rendering ...

• Email

  MailSender is a static utility class for sending email via SMTP. It wraps the mailer package.

• MongoDB

  Finch uses the mongo_dart package for MongoDB and wraps it with a small set of conventions — FinchDBConfig, DBCollection, and the DQ query builder — s...

• MySQL

  Finch uses the mysql_client_plus package for MySQL. The connection is established automatically by FinchApp at startup based on your FinchMysqlConfig ...

• SQLite

  Finch uses the sqlite3 package for SQLite. SQLite is a file-based database — there is no separate database server to manage. All data is stored in a s...

• Sqler

  Sqler is the SQL query builder used internally by Finch for MySQL and SQLite operations. It provides a fluent Dart API that generates safe, parameteri...

• Database Migration

  Database migrations are versioned scripts that track changes to your database schema over time. Instead of manually running SQL commands on each envir...

• Assets

  Assets in Finch are JavaScript and CSS files that are injected into page templates dynamically. Instead of hardcoding <script> and <link> ...

• API Documentation (Swagger / OpenAPI)

  Finch has a built-in OpenAPI documentation system. You describe each API route using ApiDoc, and Finch generates a machine-readable OpenAPI 3.1 JSON s...