https://github.com/roblesdotdev/quick-astro

A minimalist astro theme ready to use with Tailwind, Prettier, ESLint, and optimized for SEO.
https://github.com/roblesdotdev/quick-astro

astro eslint prettier tailwindcss typescript

Last synced: 2 months ago
JSON representation

A minimalist astro theme ready to use with Tailwind, Prettier, ESLint, and optimized for SEO.

• Host: GitHub
• URL: https://github.com/roblesdotdev/quick-astro
• Owner: roblesdotdev
• Created: 2024-08-17T20:11:27.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-18T23:59:19.000Z (5 months ago)
• Last Synced: 2024-10-17T13:28:54.850Z (3 months ago)
• Topics: astro, eslint, prettier, tailwindcss, typescript
• Language: Astro
• Homepage: https://quick-astro.pages.dev
• Size: 404 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



## 🚀 Quick Astro

This template comes preconfigured with commonly used tools in web development.

With minimal styling, SEO support, sitemap integration, and ViewTransition, it

also includes automated workflows for linting, formatting, and Git hooks, along

with testing setups using Vitest and end-to-end testing with Playwright, making

it a solid and efficient starting point.

### ⚒️ Usage

You can bootstrap a new Astro project using this template with the following

command:

```sh

pnpm create astro@latest --template roblesdotdev/quick-astro

```

### 💪 Features

- ✅ Minimal styling with tailwind

- ✅ SEO-friendly with canonical URLs and OpenGraph data

- ✅ Sitemap support

- ✅ ViewTransition

- ✅ Linting

- ✅ Formatting

- ✅ Git hooks

- ✅ Vitest

- ✅ Playwright

### 🧞 Commands

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 check`            | Run CLI commands `astro check` and `tsc`                                       |

| `pnpm format`           | Check format without applies changes                                           |

| `pnpm format:write`     | Format files and applies fixes                                                 |

| `pnpm lint`             | Run eslint                                                                     |

| `pnpm test`             | Vitest on dev mode(watch)                                                      |

| `pnpm test:run`         | Vitest on CI mode                                                              |

| `pnpm test:e2e`         | Run playwright dev mode                                                        |

| `pnpm test:e2e:ci`      | Run playwright on CI mode                                                      |

| `pnpm test:e2e:install` | Install playwright deps                                                        |

| `pnpm validate`         | Executes on parallel CLI commands like format, check... Executed before commit |