An open API service indexing awesome lists of open source software.

https://github.com/gitchaell/astro-template

My favorite Astro Template
https://github.com/gitchaell/astro-template

a11y astro commitlint editorconfig eslint husky i18n opengraph playwright prettier pwa seo storybook stylelint taiwlindcss typescript vercel vitest

Last synced: 20 days ago
JSON representation

My favorite Astro Template

Awesome Lists containing this project

README

          





# Astro Template (v1.0.0)

This repository provides an optimized starter template for web projects built with [Astro v5.2.5](https://astro.build/). Designed for developers seeking an efficient workflow and exceptional performance right from the start.

## Advanced Features

* **Astro v5.2.5:** Utilizes the latest Astro features for optimized performance.
* **TypeScript v5.7.3:** Fully typed for robust development.
* **Tailwind CSS v4.0.4:** For responsive and agile design.
* **Vercel Analytics v1.5.0:** Integrated for production performance monitoring.
* **Import Aliases:** Configured in `tsconfig.json` for cleaner imports.
* **Rigorous Linting & Formatting:** ESLint v9.20.0, Prettier v3.5.3, Stylelint v16.14.1, A11y v6.10.2.
* **Comprehensive Testing:** Vitest v3.0.5 for unit tests, Playwright v1.50.1 for e2e tests.
* **Git Hooks:** `lint-staged` v15.4.3 & `commitlint` v19.7.1 for code quality.
* **i18n (Internationalization):** Folder-based routing for localized content.
* **OpenGraph & Twitter Metatags:** For enhanced SEO and social sharing.
* **Astrobook (Storybook):** For isolated component development (v0.7.0).
* **Progressive Web App (PWA):** Enabled with `@vite-pwa/astro` v0.5.0.
* **Sitemap Generation:** Using `@astrojs/sitemap` v3.2.1.
* **Local Font Integration:** With custom `font-feature-settings`.
* **VitePWA Assets Generator:** `@vite-pwa/assets-generator` v0.2.6.

## Technologies and Dependencies

* **Astro:** v5.2.5
* **TypeScript:** v5.7.3
* **Tailwind CSS:** v4.0.4
* **Vercel Analytics:** v1.5.0
* **ESLint:** v9.20.0
* **Prettier:** v3.5.3
* **Stylelint:** v16.14.1
* **Vitest:** v3.0.5
* **Playwright:** v1.50.1
* **lint-staged:** v15.4.3
* **commitlint:** v19.7.1
* **Astrobook:** v0.7.0
* **@vite-pwa/astro:** v0.5.0
* **@vite-pwa/assets-generator:** v0.2.6
* **@astrojs/sitemap:** v3.2.1

## Commands

* `npm run dev`: Starts the Astro development server.
* `npm run build`: Builds the project for production.
* `npm run preview`: Previews the production build.
* `npm run format`: Formats code with Prettier.
* `npm run lint`: Runs ESLint.
* `npm run lint:fix`: Runs ESLint with auto-fix.
* `npm run lint:css`: Runs Stylelint.
* `npm run lint:css:fix`: Runs Stylelint with auto-fix.
* `npm run test`: Runs unit tests with Vitest.
* `npm run test:e2e`: Runs e2e tests with Playwright.
* `npm run test:e2e:report`: Displays Playwright test report.

## Author

**Michaell Alavedra**

* Email: f.michaell.a.m@gmail.com
* Website: [https://michaellalavedra.com](https://michaellalavedra.com)
* Repository: [https://github.com/gitchaell/astro-template](https://github.com/gitchaell/astro-template)

## License

[MIT License](LICENSE)