https://github.com/fboulnois/astro-template
A minimal Astro and Tailwind CSS template.
https://github.com/fboulnois/astro-template
astro biomejs tailwindcss typescript
Last synced: 3 months ago
JSON representation
A minimal Astro and Tailwind CSS template.
- Host: GitHub
- URL: https://github.com/fboulnois/astro-template
- Owner: fboulnois
- License: mit
- Created: 2024-09-07T18:49:16.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-20T02:00:04.000Z (10 months ago)
- Last Synced: 2025-03-16T01:11:16.744Z (7 months ago)
- Topics: astro, biomejs, tailwindcss, typescript
- Language: Astro
- Homepage:
- Size: 90.8 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# astro-template
An [Astro](https://astro.build/) project template with a few other defaults:
- [Tailwind CSS](https://tailwindcss.com/) for styling and UI
- [TypeScript](https://www.typescriptlang.org/) for type annotations
- [Biome](https://biomejs.dev/) for code linting and formatting
## Quickstart
This repository can be cloned using `degit`:
```sh
# clone `astro-template` into the `my-app` directory
pnpm dlx degit fboulnois/astro-template my-app
```
## Creating this project
> Skip this step. This step was already run and is kept for posterity.
This project was created using [`create astro`](https://docs.astro.build/en/install-and-setup).
The following steps were run to create this project:
```sh
# create a new minimal astro project
pnpm create astro -- --template minimal
# add tailwindcss as an astro plugin
pnpm astro add tailwind
# add biomejs to lint and format code
pnpm add -D @biomejs/biome
```
See the [project history](https://github.com/fboulnois/astro-template/commits/main) for other changes.
## Developing
Install the dependencies using `pnpm install`.
To check the code for issues when developing:
```sh
pnpm lint
pnpm format
pnpm check
pnpm audit
```
To start a development server:
```sh
pnpm dev
```
## Building
To create a production version of the app:
```sh
pnpm build
```
The production build can be previewed with `pnpm preview`.
> To deploy your app, you may need to install an [adapter](https://docs.astro.build/en/guides/integrations-guide/#official-integrations) for your target environment.