Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions config/theme/navbar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -450,9 +450,9 @@ const tools: NavbarItem = {
activeBasePath: 'docs/tools/openzeppelin-contracts'
},
{
to: '/docs/tools/scaffold-stellar',
label: 'Scaffold Stellar',
activeBasePath: 'docs/tools/scaffold-stellar'
to: '/docs/tools/stellar-scaffold',
label: 'Stellar Scaffold',
activeBasePath: 'docs/tools/stellar-scaffold'
},
{
to: '/docs/tools/developer-tools',
Expand Down
2 changes: 1 addition & 1 deletion docs/build/smart-contracts/getting-started/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 20

:::tip

Start with [Scaffold Stellar](https://scaffoldstellar.org/docs/quick-start) for the fastest path to a working dApp on Stellar. Scaffold Stellar is a toolkit that bundles a CLI, contract templates, a smart contract registry, and a modern frontend for building full-stack dApps.
Start with [Stellar Scaffold](https://stellarscaffold.org/docs/quick-start) for the fastest path to a working dApp on Stellar. It scaffolds the contracts, the frontend, and the wiring between them, so you get a running full-stack app before writing any of the setup yourself.

_Use this getting started guide for a lower-level tour of Stellar smart contract development from the main Stellar CLI._

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In the previous examples, we invoked the contracts using the Stellar CLI, and in

:::info

This example shows one way of creating a binding between a contract and a frontend. For a more comprehensive guide to Dapp frontends, see the [Build a Dapp Frontend](../../apps/dapp-frontend.mdx) documentation. For tooling that helps you start with smart contracts integrated with a working frontend environment quickly, jump to learn more about [Scaffold Stellar](#using-scaffold-stellar-to-rapidly-develop-dapps).
This example shows one way of creating a binding between a contract and a frontend. For a more comprehensive guide to Dapp frontends, see the [Build a Dapp Frontend](../../apps/dapp-frontend.mdx) documentation. For tooling that helps you start with smart contracts integrated with a working frontend environment quickly, jump to learn more about [Stellar Scaffold](#using-stellar-scaffold-to-rapidly-develop-dapps).

:::

Expand Down Expand Up @@ -127,52 +127,16 @@ When you start up the dev server with `npm run dev`, you will see similar output

:::

## Using Scaffold Stellar to rapidly develop dapps
## Using Stellar Scaffold to rapidly develop dapps

[Scaffold Stellar](../../../tools/scaffold-stellar.mdx) is a developer toolkit for building decentralized applications and smart contracts on the Stellar blockchain, integrated with a frontend application.
This tutorial wired a frontend to a contract by hand so you could see each piece: generate the bindings, install the package, keep the deployed contract and the generated client in sync. That loop is the same on every project, and [Stellar Scaffold](../../../tools/stellar-scaffold.mdx) exists to automate it — it scaffolds the frontend, regenerates type-safe TypeScript clients whenever your contracts change, and manages deployments across networks, so you spend your time on the app instead of the plumbing between contract and UI.

Getting a running set of smart contracts and a frontend can be done in just a few short steps with Scaffold Stellar. This tutorial will show you how to make a new Scaffold Stellar project.

If you'd like to use existing smart contracts in a Scaffold Stellar project, all you need to do is copy them to the `contracts/` folder in your project root!

1. Install the Scaffold Stellar CLI

Since you already have the Stellar CLI installed, you have everything you need to install Scaffold Stellar:

```sh
cargo binstall stellar-scaffold-cli
```

We recommend using [binstall](https://crates.io/crates/cargo-binstall) for faster installs, or use `cargo install --locked stellar-scaffold-cli`. Scaffold Stellar is a plugin on the Stellar CLI, meaning you'll use `stellar scaffold` from the command line.

2. Initialize a fresh Scaffold Stellar project

```sh
stellar scaffold init <my-project>
```

Scaffold Stellar is a plugin on the Stellar CLI, so you'll run commands as `stellar scaffold <command>`. `init` initializes a fresh Stellar Scaffold project at the provided path.

3. Install Node dependencies & set up environment variables

Make sure you already have [Node.js](https://nodejs.org/en/download/package-manager), and run:

```sh
cd <my-project> # make sure you're in your new project's directory
npm install # install frontend dependencies
cp .env.example .env # copies the example frontend environment variable file to your own copy
```

4. Start your app in development mode!
Scaffold is a plugin on the Stellar CLI you already have installed, so you run it as `stellar scaffold`:

```sh
npm start # or npm run dev
cargo install --locked stellar-scaffold-cli
```

This command does two tasks concurrently: it runs `stellar scaffold watch --build-clients` which compiles your smart contracts, updating them as you change them, deploying them to your local Stellar chain (make sure Docker is running!), and configures all these settings via your `environments.toml` file in your root project folder.

The second task it runs is `vite`, a popular JavaScript build tool to compile and watch your React frontend for changes.

After a little compiling time, you'll be able to see your running app at [localhost:5173](http://localhost:5173)!
From there, [`stellar scaffold init`](https://stellarscaffold.org/docs/quick-start) creates a project with contracts, a frontend, and a live dev loop already wired together. Existing contracts work too — Scaffold picks them up from the project's contracts directory.

Learn more about [Scaffold Stellar](../../../tools/scaffold-stellar.mdx).
For the full walkthrough, including local network setup, environment configuration, and deploying to testnet and mainnet, see the [Stellar Scaffold quick start](https://stellarscaffold.org/docs/quick-start).
4 changes: 2 additions & 2 deletions docs/tools/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ OpenZeppelin Relayer, also known as Stellar Channels Service, is a managed infra

OpenZeppelin Stellar Contracts is a collection of audited contracts and utilities for Stellar. The contracts are developed by OpenZeppelin in collaboration with the Stellar community and the Stellar Development Foundation (SDF), in an effort to bring a library of high-quality and audited contracts that can be used to build applications on the Stellar network.

### [Scaffold Stellar](./scaffold-stellar.mdx)
### [Stellar Scaffold](./stellar-scaffold.mdx)

Scaffold Stellar is a developer toolkit for building decentralized applications (dApps) and smart contracts on Stellar. It provides CLI tools, reusable contract templates, a smart contract registry, and a modern frontend.
Stellar Scaffold is a full-stack toolkit for building decentralized applications (dApps) and smart contracts on Stellar, wrapping the contract-to-frontend workflow end to end.

### [More Developer Tools](./developer-tools/README.mdx)

Expand Down
8 changes: 7 additions & 1 deletion docs/tools/cli/plugins-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,16 @@ This is a list of all plugins made available by the community, so please review

### [stellar-scaffold/cli](https://github.com/stellar-scaffold/cli)

The Stellar app lifecycle streamlined. `stellar scaffold` CLI: init, learn, &amp; build ambitious apps. `stellar registry` CLI: author, publish, deploy &amp; upgrade Wasm binaries + smart contracts (or use someone else's)
The easiest way to build Stellar apps. One command scaffolds your contracts, a modern frontend, and type-safe clients that connect the two, keeping everything in sync as you build so you don't have to.

[https://github.com/stellar-scaffold/cli](https://github.com/stellar-scaffold/cli)

### [stellar-registry/cli](https://github.com/stellar-registry/cli)

Stellar CLI plugin for publishing and deploying contracts via the on-chain registry

[https://github.com/stellar-registry/cli](https://github.com/stellar-registry/cli)

### [lightsail-network/stellar-contract-bindings](https://github.com/lightsail-network/stellar-contract-bindings)

CLI tool designed to generate language bindings for Stellar Soroban smart contracts.
Expand Down
2 changes: 1 addition & 1 deletion docs/tools/openzeppelin-contracts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For latest OpenZeppelin developer docs, please visit: [https://docs.openzeppelin

## Getting started with Contract Wizard

[OpenZeppelin's Contract Wizard](https://wizard.openzeppelin.com/stellar) includes support for Stellar’s Rust-based smart contracts, making it easier for developers to generate and deploy secure, audited contracts. After you have selected your desired template and options you can download it as a single file, a Rust development package, or a [Scaffold Stellar Package](./scaffold-stellar). Try it out below or visit the wizard [here](https://wizard.openzeppelin.com/stellar).
[OpenZeppelin's Contract Wizard](https://wizard.openzeppelin.com/stellar) includes support for Stellar’s Rust-based smart contracts, making it easier for developers to generate and deploy secure, audited contracts. After you have selected your desired template and options you can download it as a single file, a Rust development package, or a [Stellar Scaffold Package](./stellar-scaffold). Try it out below or visit the wizard [here](https://wizard.openzeppelin.com/stellar).

<oz-wizard data-lang="stellar"></oz-wizard>

Expand Down
135 changes: 0 additions & 135 deletions docs/tools/scaffold-stellar.mdx

This file was deleted.

38 changes: 38 additions & 0 deletions docs/tools/stellar-scaffold.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Stellar Scaffold
description: A full-stack toolkit for building Stellar dApps — CLI, frontend templates, and an on-chain contract registry
sidebar_label: Stellar Scaffold
sidebar_position: 45
---

## [Stellar Scaffold](https://stellarscaffold.org)

Stellar Scaffold is a full-stack toolkit for building decentralized applications (dApps) and smart contracts on Stellar. If you've used the [Stellar CLI](https://github.com/stellar/stellar-cli) to write and deploy Soroban contracts, Scaffold wraps that workflow end to end: it scaffolds a TypeScript frontend, keeps type-safe contract clients in sync with your deployed contracts as you change them, and manages deployments across networks — so your time goes to your app instead of the plumbing between contract and UI.

It is an officially sanctioned [Stellar Development Foundation Public Good](https://stellar.org/grants-and-funding), actively maintained with community input into its roadmap.

![Stellar Scaffold](https://stellarscaffold.org/img/code_hero.svg)

## What you get

- **[CLI plugin](https://stellarscaffold.org/docs/cli)** — `stellar scaffold` starts a new project, converts an existing Soroban workspace into one, and runs a live dev loop that rebuilds contracts and regenerates their clients as you edit. Source at [stellar-scaffold/cli](https://github.com/stellar-scaffold/cli).

- **[Frontend templates](https://github.com/stellar-scaffold/ui)** — official React and SvelteKit starting points, each with a wallet integration and a browser-based contract debugger.

- **Type-safe contract clients** — your Rust contracts become typed TypeScript clients automatically, so the frontend calls them with full editor autocomplete instead of hand-written request code.

- **[Smart contract registry](https://stellarscaffold.org/docs/registry)** — an on-chain registry for publishing Wasm binaries under versioned, human-readable names, then deploying and managing them across testnet and mainnet. Hosted at [rgstry.xyz](https://rgstry.xyz); source at [stellar-registry/cli](https://github.com/stellar-registry/cli).

## Get started

Follow the [Stellar Scaffold quick start](https://stellarscaffold.org/docs/quick-start) to install the CLI and create your first project.

## Learn more

- Documentation, guides, and reference: [stellarscaffold.org](https://stellarscaffold.org)
- Step-by-step [video series on YouTube](https://www.youtube.com/playlist?list=PLmr3tp_7-7Gjj6gn5-bBn-QTMyaWzwOU5)
- What people are building, and how to submit your own project: [showcase](https://stellarscaffold.org/showcase)

## Help us improve

Stellar Scaffold is open source and we welcome your feedback. File bugs and feature requests on [GitHub](https://github.com/stellar-scaffold/cli/issues) — your input shapes where the toolkit goes next.
1 change: 1 addition & 0 deletions nginx/includes/redirects.conf
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ rewrite ^/docs/software-and-sdks$ "/docs/tools/sdks" permanent;
rewrite ^/docs/tools-and-sdks(.*)$ "/docs/tools/sdks$1" permanent;
rewrite ^/docs/data/indexers/data-indexers$ "/docs/data/indexers/indexer-providers" permanent;
rewrite ^/docs/tools/developer-tools/data-indexers "/docs/data/indexers/data-indexers" permanent;
rewrite ^/docs/tools/scaffold-stellar$ "/docs/tools/stellar-scaffold" permanent;
rewrite ^/docs/data/indexers/indexer-providers(/indexer-providers)?$ "/docs/data/indexers" permanent;
rewrite ^/docs/start/introduction$ "/docs" permanent;
rewrite ^/docs/start/list-of-operations$ "/docs/learn/fundamentals/list-of-operations" permanent;
Expand Down
2 changes: 1 addition & 1 deletion routes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -817,11 +817,11 @@
/docs/tools/quickstart/network-modes
/docs/tools/ramps
/docs/tools/ramps/moneygram
/docs/tools/scaffold-stellar
/docs/tools/sdks
/docs/tools/sdks/build-your-own
/docs/tools/sdks/client-sdks
/docs/tools/sdks/contract-sdks
/docs/tools/stellar-scaffold
/docs/validators
/docs/validators/admin-guide
/docs/validators/admin-guide/advanced
Expand Down
Loading
Loading