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

# Contributing to StellarPlan Web

## Getting started

```bash
npm install
cp .env.example .env.local
npm run dev
```

The web app expects the API at `NEXT_PUBLIC_API_URL` (see `.env.example`).

## Workflow

1. Branch from `main`.
2. Add or update a screen under `app/`, shared UI under `components/`, data access only via `lib/api.ts`, wallet access only via `lib/freighter.ts`.
3. `npm run build` must pass before opening a PR (it type-checks everything).
4. Conventional commits.

## Auth rules

* Authentication is **Freighter wallet only**. Never add an email/password field, and never add an input that accepts a raw secret key — signing happens inside Freighter, keys never touch the app.
* All wallet interaction goes through `lib/freighter.ts`; don't call `@stellar/freighter-api` directly from components.

## Design system rules

* Use the palette tokens (`bg-jade`, `text-muted`, `bg-clay/...`) — no raw hex in components.
* Balances and IDs always use the `data-balance` attribute (IBM Plex Mono, tabular numbers).
* Vault surfaces use `.vault-card`; never roll a custom shadow/border for plan cards.
* Animations < 300 ms and must respect `prefers-reduced-motion`.
* Product language is "Plans / Protected / Release" — never "vault / smart contract / escrow" in UI copy.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://stellarplan.gitbook.io/stellarplan-docs/contributing.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.