Get Started with Conduit

It only takes a few minutes.

(Migrating from Aqueduct? Click here)

  1. Install the Dart programming environment locally. If you’ve previously installed it through Flutter, you’ll want to install it again separately for Conduit. Full instructions on the Dart site

    $ sudo sh -c 'wget -qO- https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -'
    $ sudo sh -c 'wget -qO- https://storage.googleapis.com/download.dartlang.org/linux/debian/dart_stable.list > /etc/apt/sources.list.d/dart_stable.list'
    $ sudo apt-get update
    $ sudo apt-get install dart
    $ echo 'export PATH="$PATH:/usr/lib/dart/bin"' >> ~/.profile
    $ # Test that it works - display version string
    $ dart --version
    $ brew tap dart-lang/dart
    $ brew install dart
    $ # Test that it works - display version string
    $ dart --version
    $ :: (in an administrator command line)
    $ choco install dart-sdk
    $ :: Test that it works - display version string
    $ dart --version
  1. Activate the Conduit CLI (command line interface), which helps you easily create, manage, and test your Conduit projects.

     pub global activate conduit
     conduit --version 
     # “Conduit CLI version: x.y.z”
    
  2. Create and run your new Conduit project using the Conduit CLI.

    After running conduit serve, you should see a port listed, such as 8888 or 8080. In your web browser of choice, navigate to http://localhost:xxxx where xxxx is the port number. You should see ‘404 Not Found’ displayed in bold text.

     conduit create my_project
     cd my_project
     conduit serve
    
  3. Open the project folder in your favorite IDE with Dart support, such as VS Code with the Dart Code extension or JetBrains WebStorm. See a full list of IDEs with Dart support >

     code .
    

Setup is now complete! If you need help, we recommend asking on our Discord. Otherwise, now’s a good time to check out the heroes tutorial or the docs.