Getting Started / Installation

Creating Your First Project

Getting started with Archery is straightforward. This guide will walk you through the prerequisites and the steps to set up your first Archery project.

Prerequisites

Before you begin, ensure you have the following installed on your system:

  • Dart SDK: Archery requires Dart SDK ^3.2.0. You can download it from the official Dart website.
  • A Database (Optional for getting started): Archery supports SQLite, Postgres, and JSON file storage. For quick prototyping, the JSON and SQLite drivers require no additional setup.

1. Create a New Project

Currently, the best way to start a new Archery project directly from the source or by adding it as a dependency in a standard Dart project.

  1. Clone the Archery repository:

    git clone https://github.com/webarchery/archery.git my_app
    cd my_app
    
  2. Get the dependencies:

    dart pub get
    

2. Launching the Server

Run your application using the Dart VM:

dart run bin/server.dart

You should see a message indicating the server is running: 

🔥 Archery server running at http://localhost:5501