A CLI for scaffolding ATProto web applications
TypeScript 57.6%
CSS 20.9%
Svelte 10.9%
JavaScript 10.6%
74 1 7

Clone this repository

https://tangled.org/besaid.zone/create-atproto-app https://tangled.org/did:plc:qttsv4e7pu2jl3ilanfgc3zn/create-atproto-app
git@tangled.org:besaid.zone/create-atproto-app git@tangled.org:did:plc:qttsv4e7pu2jl3ilanfgc3zn/create-atproto-app

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
README.md

create-atproto-app#

This CLI is a thin wrapper on top of create-vite that adds starter code for working with the AT Protocol.

WARNING

We are still working out the proper setups for all of the templates, there could be breaking changes!

Getting Started#

The easiest way to get started is to invoke the init command which will take you through a set of prompts to generate a starter app.

npx @nulfrost/create-atproto-app@latest init

If you already have an idea of the framework you want to use you can skip the prompts entirely with these command line options:

  • --name - the name of your project
  • --framework - framework is just the frontend library you would like to use. see Supported Templates to see which frameworks are supported.
  • --variant - which variant of the framework you'd like to use. for example, if you select react you'll have react router, tanstack router, next etc as options. see Variants for which variants are supported currently.
npx @nulfrost/create-atproto-app@latest init --name my-project --framework react --variant react-ts

Variants:#

  • react-ts
  • svelte-ts
  • vanilla

Supported templates#

  • HTML + JavaScript
  • React + TypeScript
    • React Router
    • Tanstack Router
    • Tanstack Start
    • Next.js
  • Svelte + TypeScript
    • SvelteKit
  • Vue + TypeScript
    • Nuxt
  • Solid + TypeScript
    • Solid Start
  • Angular + TypeScript
    • Analog

Contributing#

See CONTRIBUTING.md if you would like to add a feature/make a bug fix.