The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
Astro Starter Kit: Basics
npm create astro@latest -- --template basics
π§βπ Seasoned astronaut? Delete this file. Have fun!
π Project Structure
Inside of your Astro project, you'll see the following folders and files:
/
βββ public/
β βββ favicon.svg
βββ src
β βββ assets
β β βββ astro.svg
β βββ components
β β βββ Welcome.astro
β βββ layouts
β β βββ Layout.astro
β βββ pages
β βββ index.astro
βββ package.json
To learn more about the folder structure of an Astro project, refer to our guide on project structure.
π§ Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
π Want to learn more?
Feel free to check our documentation or jump into our Discord server.
Federated troubleshooting content
src/content/troubleshooting/ isn't hand-written β it's fetched from a private repo by
scripts/federated-content/fetch-federated-content.ts as part of the build (pnpm run fetch:federated-content)
and is gitignored. See AGENTS.md for how it works and what's intentionally left out for now.
Workflows
.github/workflows/kb-troubleshooting-sync.yml runs on every push to master: it fetches troubleshooting
content, creates a GitHub Discussion for any guide that doesn't have one yet
(sync:troubleshooting-entries), and pushes title/content updates to discussions whose guide has since
changed (sync:troubleshooting-updates). This is separate from kb's own build β it has real side effects
(creating/updating Discussions, writing DB rows), so it never runs as part of pnpm build/prebuild.
Tests
Unit tests (vitest) live next to the code they cover, including the search API (api/search/_search.test.ts;
the _ prefix keeps Vercel from deploying it as a function). Run them from apps/kb:
pnpm test
.github/workflows/kb-tests.yml runs them on pull requests that touch apps/kb.
Functional smoke tests (Playwright) live in e2e/kb and cover the key /kb journeys: home β topic β guide,
troubleshooting articles, the markdown export (.md and Accept: text/markdown), and the search API
(production only, since previews don't have search configured). They run against
production by default. Install the browser once, then run from the repository root:
pnpm -C e2e/kb exec playwright install chromium
pnpm e2e:kb
# Against a preview or local build
PLAYWRIGHT_BASE_URL=https://<preview-url> pnpm e2e:kb
.github/workflows/kb-e2e.yml runs the smoke tests on pull requests against the PR's Vercel kb preview (or
production, when only e2e/kb changed), and daily against production. Run it manually with a base_url to test any other deployment.