91 lines
2.7 KiB
Markdown
91 lines
2.7 KiB
Markdown
# 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
|
|
|
|
```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 colors in tailwind.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 |
|
|
|
|
## Acknowledgements
|
|
|
|
- [Astro.js Basic Example](https://github.com/withastro/astro/tree/main/examples/basics)
|
|
- [Astro.js Docs](https://docs.astro.build/)
|
|
- [Astro Starter Kit](https://github.com/zankhq/astro-starter)
|
|
- [Docker](https://www.docker.com/)
|
|
- [Frontmatter CMS](https://frontmatter.codes/)
|
|
- [Material-Tailwind](https://www.material-tailwind.com/)
|
|
- [nginx](https://www.nginx.com/)
|
|
- [Node.js](https://nodejs.org/en)
|
|
- [pnpm](https://pnpm.io/)
|
|
- [Prettier](https://prettier.io/)
|
|
- [Radix UI](https://www.radix-ui.com/)
|
|
- [React](https://react.dev/)
|
|
- [shadcn/ui Docs](https://ui.shadcn.com/docs)
|
|
- [Tailkit](https://tailkit.com/)
|
|
- [Tailwind CSS Docs](https://tailwindcss.com/docs/)
|
|
- [Typescipt](https://www.typescriptlang.org/)
|
|
- [Visual Studio Code](https://code.visualstudio.com/)
|