pnpm create astro@latest -- --template jllahi/astrokit-minimal
🧑🚀 Seasoned astronaut? Delete this file. Have fun!
- React: pnpm astro add react -y
- Svelte: pnpm astro add svelte -y
- DB: pnpm astro add db -y
- SSR: pnpm astro add vercel -y
Inside of your Astro project, you'll see the following folders and files:
/
├── public/
├── src/
│ └── pages/
│ └── index.astro
└── package.json
Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.
There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the public/ directory.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install |
Installs dependencies |
pnpm dev |
Starts local dev server at localhost:4321 |
pnpm build |
Build your production site to ./dist/ |
pnpm preview |
Preview your build locally, before deploying |
pnpm astro ... |
Run CLI commands like astro add, astro check |
pnpm run astro -- --help |
Get help using the Astro CLI |
pnpm format |
Format your code using Prettier |
pnpm lint |
Lint your code using Eslint |
pnpm clean |
Remove generated code |
| File(s) | Description |
|---|---|
tailwind.config.mjs |
Config file for Tailwind CSS |
prettier.config.mjs |
Config file for Prettier |
/data/config.ts |
Data for config variables used globally |
/utils/styles.ts |
Functions for handling styles |
/pages/api/preview.ts |
Serverless route for triggering Preview mode |
/schemas |
Where Sanity Studio gets its content types from |
/plugins |
Where the advanced Sanity Studio customization is setup |
/lib/sanity.api.ts,/lib/sanity.image.ts |
Configuration for the Sanity Content Lake client |
/lib/sanity.preview.ts |
Configuration for the live Preview Mode |
Feel free to check our documentation or jump into our Discord server.