> For the complete documentation index, see [llms.txt](https://flutter-nakama.gitbook.io/flutter-nakama/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://flutter-nakama.gitbook.io/flutter-nakama/development/setup.md).

# Setup

This article covers how to set up your development environment for this package.

Starting your development on this package is quite simple. You just need a local Nakama instance. This package provides an out of the box running *docker-compose.yaml* file.

## Setup package + Nakama

{% hint style="danger" %}
Please notice, that this package **only supports flutter ≥ 2**!
{% endhint %}

Check out the git repo and `cd` to it.

```bash
# Check your local environment
flutter doctor -v

# Install the packages dependencies
flutter pub get

# Run your local Nakama instance
cd tools/nakama_server
docker-compose up

# Ready!
echo "Ready to go 🚀"

# Run the tests > should succeed with that default installation
flutter test
```
