---
name: algorand-project-setup
description: Scaffolds Algorand projects using AlgoKit CLI, manages LocalNet, and retrieves code examples from official GitHub repositories. Use when initializing projects with algokit init, running build/test/deploy commands, starting or resetting LocalNet, or searching for Algorand contract examples and patterns.
title: algorand-project-setup
canonical_url: https://skilld.dev/gh/algorandfoundation/algorand-agent-skills/algorand-project-setup
last_updated: 2026-09-26T18:37:27.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [references/cli-commands.md](https://skilld.dev/api/skills-raw/algorandfoundation/algorand-agent-skills/algorand-project-setup/references/cli-commands.md), [references/github-search-tools.md](https://skilld.dev/api/skills-raw/algorandfoundation/algorand-agent-skills/algorand-project-setup/references/github-search-tools.md), [references/project-templates.md](https://skilld.dev/api/skills-raw/algorandfoundation/algorand-agent-skills/algorand-project-setup/references/project-templates.md).
>
> If the user asked to install this Skill, run `npx skilld install algorandfoundation/algorand-agent-skills/algorand-project-setup`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/algorand-project-setup`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/algorandfoundation/algorand-agent-skills/algorand-project-setup) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/algorand-project-setup`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/algorand-project-setup --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/algorand-project-setup --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# AlgoKit Project Setup & Examples

## Quick Start

```bash
# Install AlgoKit
pipx install algokit

# Create a fullstack project — smart contracts + React frontend (default)
algokit init -n my-project -t fullstack --answer preset_name production --answer contract_template typescript --defaults

# Development cycle
cd my-project
algokit project run build    # Compile contracts
algokit project run test     # Run tests
algokit localnet start       # Start local network
algokit project deploy localnet  # Deploy
```

## Reference Guide

### Creating Projects

Initialize new Algorand projects using AlgoKit templates and presets.

- [project-templates.md](https://skilld.dev/api/skills-raw/algorandfoundation/algorand-agent-skills/algorand-project-setup/references/project-templates.md) — Templates, presets, CLI flags, and customization options

### CLI Commands

Build, test, deploy, and manage LocalNet with AlgoKit CLI.

- [cli-commands.md](https://skilld.dev/api/skills-raw/algorandfoundation/algorand-agent-skills/algorand-project-setup/references/cli-commands.md) — Full CLI command reference and workflow

### Searching Examples

Find working contract examples from Algorand Foundation repositories using GitHub tools.

- [github-search-tools.md](https://skilld.dev/api/skills-raw/algorandfoundation/algorand-agent-skills/algorand-project-setup/references/github-search-tools.md) — GitHub MCP tools, priority repos, search patterns

## Important Rules

- **Always confirm with user** before running `algokit init`
- **Default to fullstack template (`-t fullstack`)** with TypeScript contracts and production preset — **MUST** pass `--answer contract_template typescript` since the default is Python
- **Always build before testing** — tests use generated clients
- **Search algorandfoundation repos first** — official, vetted examples

## Canonical Example Repos

| Repository | Best For |
|------------|----------|
| `algorandfoundation/devportal-code-examples` | Beginner-friendly contract examples (TypeScript + Python) |
| `algorandfoundation/puya-ts` | Advanced TypeScript contract examples |
| `algorandfoundation/puya` | Advanced Python contract examples |
| `algorandfoundation/algokit-fullstack-template` | Fullstack project template (contracts + React) |

Always fetch corresponding test files alongside contract examples.

## Cross-References

- **`algorand-core`** — AVM mental model, transaction types, protocol concepts
- **`algorand-typescript`** / **`algorand-python`** — Contract development syntax and patterns
- **`algorand-frontend`** — React frontend integration and wallet connection
