Astro Deploy Starter
A custom Astro.js template
Features
- 🚀 Astro.js 4
- 🐳 Docker integration
- 🍃 Tailwind CSS
- 🖊️ MDX Blog
- 🐇 Directus CMS support
- ⚛️ React.js
- 🏔️ Alpine.js integration
- 📘 TypeScript
How to use this template
git clone https://github.com/deployn/astro-deploy new-astro-project
cd new-astro-project
- Update /public/logo.svg
- Update /public/site.webmanifest
- Update astro.config.mjs
- Update colors in tailwind.config.mjs
- Update /src/*
Directus
If you don't want to use Directus CMS:
- Delete /src/lib/directus.ts
- Delete /src/pages/recipes.astro
pnpm remove @directus/sdk
If you want to use Directus, make sure to grant the view permission to the public for the collection(s) you want to use and directus_fields in your Directus dashboard. Adjust the /src/lib/directus for your content.
Add shadcn/ui components
Visit https://ui.shadcn.com/docs/ for a list of components
pnpm dlx shadcn-ui@latest add componentName
Start the Server
Development Server:
npm i -g pnpm
pnpm install
pnpm dev
Production Build:
sudo docker build . --build-arg SITE_URL=https://example.com --build-arg DIRECTUS_URL=https://example.directus.com -t astro-deploy
docker run -d -p 1234:80 astro-deploy
🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install |
Installs dependencies |
pnpm run dev |
Starts local dev server at localhost:4321 |
pnpm run build |
Build your production site to ./dist/ |
pnpm run preview |
Preview your build locally, before deploying |
pnpm run astro ... |
Run CLI commands like astro add, astro check |
pnpm run astro -- --help |
Get help using the Astro CLI |
pnpm run upgrade |
Upgrade dependencies interactively |
pnpm run format |
Formats codebase using Prettier |
pnpm run commit |
Commits changes to version control |