64 lines
1.7 KiB
Markdown
64 lines
1.7 KiB
Markdown
# Astro Deploy Starter
|
|
|
|
## Features
|
|
|
|
- 🚀 Astro.js 4
|
|
- 🐳 Docker integration
|
|
- 🍃 Tailwind CSS
|
|
|
|
## How to use this template
|
|
|
|
```sh
|
|
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 /src/\*
|
|
|
|
### Add shadcn/ui components
|
|
|
|
Visit <https://ui.shadcn.com/docs/> for a list of components
|
|
|
|
```sh
|
|
pnpm dlx shadcn-ui@latest add componentName
|
|
```
|
|
|
|
### Start the Server
|
|
|
|
Development Server:
|
|
|
|
```sh
|
|
npm i -g pnpm
|
|
pnpm install
|
|
pnpm dev
|
|
```
|
|
|
|
Production Build:
|
|
|
|
```sh
|
|
sudo docker build . --build-arg SITE_URL=https://example.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 |
|