Skip to main content
Clone the Archery repository when you want the framework source, bundled example application, configuration, tests, and full Git history in one working directory.
This is the recommended path for exploring Archery, contributing to the framework, or building directly from the repository. It does not create a separate Dart console project.

​
Prerequisites

Install Git and Dart 3.10 or later, then confirm both commands are available:

Install the Dart SDK

Follow the official Dart installation instructions if dart is unavailable or reports a version older than 3.10.

​
Clone the repository

Clone Archery from GitHub and enter the repository:
The clone contains the framework source, default configuration, HTTP routes, views, database code, tests, and the bundled example entry point.
Pass the destination name as the final argument:

​
Install dependencies

Resolve the packages declared by the repository:

​
Run the Archery server

Start the example server from the repository root:
The default example listens on the port configured by lib/src/config/server.json, falling back to port 5502. Open the application in a browser or request it from another terminal:
Stop the development server with Ctrl+C.

​
Understand what was installed

The most useful starting locations are: The repository includes more functionality than the minimal server used in the Quickstart.
Do not commit passwords, database credentials, AWS keys, or production secrets into the repository’s JSON configuration files. Inject secrets through the deployment environment.

Run the quickstart

Reduce the bundled application to Archery’s essential boot sequence.

Project structure

Learn where the repository’s application components belong.