Installatie

Finch is een server-side webframework voor Dart. Deze pagina beschrijft de vereisten en de stappen om het te installeren.

Vereisten

  • Dart SDK — Finch vereist Dart 3.x of hoger. Download via dart.dev/get-dart.
  • Een terminal en een teksteditor (VS Code met de Dart-extensie wordt aanbevolen).

Finch CLI installeren

De Finch CLI biedt project-scaffolding, build-, serve- en migratieopdrachten.

dart pub global activate finch

Controleer na de activering de installatie:

finch --version

Een nieuw project aanmaken

finch create

Zonder vlaggen uitgevoerd, vraagt finch create interactief om een projectnaam en of je Docker wilt gebruiken. Voor al het andere geldt een verstandige standaardwaarde: het project wordt aangemaakt in een map met dezelfde naam als het project, en het sjabloon staat standaard op simple tenzij je dit overschrijft met -t/--template. Om de prompts volledig over te slaan:

finch create -n my_app -p ./my_app -t example -d

Voer finch templates uit om de officiële sjablonen te zien die beschikbaar zijn voor -t (deze worden live van GitHub opgehaald). Het example-sjabloon komt overeen met het project dat doorheen deze documentatie wordt gebruikt en bevat voorbeelden van MongoDB, MySQL, SQLite, WebSocket, i18n, formulieren en API-documentatie; simple is een minimaal startpunt. Als je -d/--docker niet meegeeft en "nee" antwoordt op de Docker-prompt, worden de Dockerfile, .dockerignore en docker-compose.yaml van het gegenereerde project automatisch verwijderd.

Het nieuwe project uitvoeren

cd my_app
dart pub get
finch serve

finch serve start de ontwikkelserver met een bestandswatcher — widget- en taalbestanden worden automatisch opgepikt zonder herstart. Zie Running an Application voor het verschil tussen serve (ontwikkeling) en een gecompileerde binary (productie).

Finch toevoegen aan een bestaand project

dart pub add finch

Voer vervolgens uit:

dart pub get

Je moet zelf nog de lib/app.dart-opzet en een routingfunctie aanmaken — zie Running an Application voor de minimale structuur, aangezien dart pub add alleen de dependency toevoegt, niet de scaffolding die finch create genereert.

Finch bijwerken

finch -u

Werkt de globaal geactiveerde finch-CLI zelf bij (gelijk aan het opnieuw uitvoeren van dart pub global activate finch). Om de finch-package-dependency binnen een project bij te werken, gebruik je in plaats daarvan de normale Dart-tooling: dart pub upgrade finch.

Volgende stap

Zie Finch CLI voor alle beschikbare opdrachten, of ga direct naar Configuration om je eerste applicatie in te stellen.