Skip to content

mrsuner/astro-starter-template

Repository files navigation

Astro Starter Kit: SunDev

This is a starter template to let you quick start with a website using Astro.

🚀 Project Structure

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

/
├── public/
├── src/
├── └── content
├── └── config
├── └── assets
├── └── └── images
├── └── └── css
├── └── └── js
├── └── components
├── └── 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:3000
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 astro --help Get help using the Astro CLI

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.

About

A starter template for Astro

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published