Skip to content

Astro basic template config with typescript, tailwind, prettier & standard

Notifications You must be signed in to change notification settings

tinchoz49/astro-starter

Repository files navigation

Astro Starter

Open in StackBlitz Open with CodeSandbox

About

This is an starter Astro project with:

  1. astro files are being lint and format with the Anthony's ESLint config preset
  2. tailwind support
  3. vitest support

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
│   └── favicon.svg
├── src/
│   ├── components/
│   │   └── Card.astro
│   ├── layouts/
│   │   └── Layout.astro
│   └── pages/
│       └── index.astro
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run check Check your project for errors
npm run astro -- --help Get help using the Astro CLI
npm run fix Format with ESLint
npm run lint Lint files with standard
npm test Run your tests with vitest

About

Astro basic template config with typescript, tailwind, prettier & standard

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published