# Use and adapt partners

Use the documented interfaces and source layout for **partners**. The sections below retain the README’s examples and configuration details.

## Local Development

- Default local URL: `http://localhost:3002`
- `pnpm --filter ./partners dev` starts on `3002`, or the next open port when `3002` is busy.
- `/signup` creates a Partner Programmer account and a programmer organization for app review work.
- `/dashboard/account` manages the developer profile and programmer organization.
- `pnpm --filter ./partners convex:dev` runs the Partners Convex backend.

## Portal Architecture

- `server/` repositories are the boundary for server-side Convex calls.
- `hooks/` contains client hooks for account, organization, avatar, app form, and access checkpoint state.
- `stores/` contains Zustand UI stores for portal chrome, account snapshots, and app permission checkpoints.
- `types/`, `utilities/`, and `validation/` hold shared contracts, pure helpers, and Zod schemas.
- `security/`, `trust/`, and `rate-limits/` are only used where runtime wrappers need production checks, trusted auth headers, or sensitive-route throttling.

## Commands in the root manifest

The captured [package.json](https://github.com/Up-to-code/partners/blob/HEAD/package.json) declares the following scripts. Run them from the directory containing that manifest.

| Command | Script |
| --- | --- |
| `npm run dev` | `node scripts/dev-next.mjs` |
| `npm run build` | `next build` |
| `npm run test` | `vitest run` |
| `npm run typecheck` | `tsc --noEmit` |
| `npm run start` | `next start --port 3002` |

## Troubleshoot a local change

1. Reproduce the smallest example from the [quick-start guide](/docs/up-to-code-partners/quick-start-guide).
2. Compare required configuration and dependency versions with the README.
3. Check the linked issue tracker for the same error. Include the command, runtime version, and relevant error when reporting a problem; omit credentials.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/partners)
- [Original README](https://github.com/Up-to-code/partners/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/partners/issues)
