Installation

Learn how to install and set up AlgoKit in your Dart project

Installation

Getting started with AlgoKit is straightforward. Follow these steps to add AlgoKit to your Dart project.

Prerequisites

Before installing AlgoKit, ensure you have:

  • Dart SDK version 2.12.0 or higher
  • A Dart project initialized with pubspec.yaml

Adding AlgoKit to Your Project

Using dart pub

Add AlgoKit to your project using the Dart package manager:

dart pub add algokit

Using flutter pub

If you're using Flutter, you can add AlgoKit using:

flutter pub add algokit

Manual Installation

Alternatively, you can manually add AlgoKit to your pubspec.yaml:

dependencies:
  algokit: ^1.0.0  # Replace with the latest version

Then run:

dart pub get

Importing AlgoKit

After installation, you can import AlgoKit in your Dart files:

import 'package:algokit/algokit.dart';

For specific modules, you can use more targeted imports:

// For sorting algorithms
import 'package:algokit/sorting.dart';

// For data structures
import 'package:algokit/data_structures.dart';

Next Steps

Now that you have AlgoKit installed, you can:

  1. Read through our documentation to understand core concepts
  2. Start integrating AlgoKit into your existing projects
  3. Join our community to get help and share your experience
  4. Contribute to the project by submitting bug reports or feature requests

Troubleshooting

If you encounter any issues during installation:

  1. Ensure your Dart SDK version is compatible
  2. Check that your pubspec.yaml file is properly formatted
  3. Try running dart pub cache clean and then dart pub get
  4. Visit our Issues page for known problems and solutions