😀Installation

How we install the framework

Before creating your first DartStream application, ensure that your local machine has Dart, and the DartStream CLI installed. Additionally, for projects requiring frontend frameworks, you should install either Node.js and npm or Bun to manage your frontend dependencies.

Installing Dart and DartStream CLI

If you don't have Dart and Dart Pub installed on your local machine, you can follow the commands below to install Dart along with the DartStream CLI on macOS, Windows, or Linux.

Install Dart

macOS:

Run the following command to install Dart and the DartStream CLI:

/bin/bash -c "$(curl -fsSL https://dart.new/install/mac/latest)"

Windows PowerShell:

Execute the command below in PowerShell to install Dart and DartStream:

Invoke-WebRequest -Uri https://dart.new/install/windows/latest -OutFile install.ps1; powershell -ExecutionPolicy Bypass -File ./install.ps1  

Linux:

Run the following command in your terminal to install Dart and DartStream:

/bin/bash -c "$(curl -fsSL https://dart.new/install/linux/latest)"  

Post-Installation Steps

1. After running the appropriate installation command, restart your terminal session to ensure the changes take effect.

2. To update the Dart SDK in the future, re-run the installation command for your platform.

Install DartStream CLI

If the Dart SDK is already installed on your machine, you can install the DartStream CLI using the following steps:

1. Clone the DartStream repository on GitHub:

git clone https://github.com/aortem/dartstream.git

1. Run the command below to make dartstream available available in your terminal:

dart pub global activate --source path ./dartstream/dartstream_backend/packages/cli/ds_cli/

After installation, the dartstream command will be globally available in your terminal. You can verify the installation with:

dartstream list

Your terminal should show the output below:

Usage: dartstream <command> [arguments]

Available commands:
  init                     Initialize a new Dartstream project.
  configure                Configure core project components like cloud provider and framework.
  enable-extension         Enables a specified extension.
  disable-extension        Disables a specified extension.
  setup                    Set up middleware, CI/CD, and additional tools.
  discover                 Discovers, validates, and dynamically registers extensions.
  generate                 Generate project files based on the configuration.
  validate                 Validates all discovered extensions for manifest correctness and dependency compatibility.
  extensions               Lists all discovered and registered extensions.
  list                     Lists all available commands for Dartstream.

Additional Requirements for Frontend Development

DartStream supports frontend frameworks like Vue.js, React, Svelte, Flutter web etc., each frontend framework has slightly different requirements which will be listed below:

React

Vue.js

Svelte

Android Compose

Flutter Web

Flame

Next Steps

With Dart, and DartStream CLI installed, you’re ready to create your first DartStream project. Check out the Project Initialization section to start building your application!