Netlify Astro Starter

This is Astro's default starter site, ready to deploy to Netlify.

Working Locally

To work locally on a machine with Node.js v18 installed, clone the repository:

git clone [email protected]:netlify/netlify-astro-starter.git

Change into the project directory and install the dependencies:

cd netlify-astro-starter
yarn install

Start the development server:

yarn dev

The development site will be available at http://localhost:4321. Happy coding! 🚀

About the Project

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
yarn install	Installs dependencies
yarn dev	Starts local dev server at localhost:4321
yarn build	Build your production site to ./dist/
yarn preview	Preview your build locally, before deploying
yarn astro ...	Run CLI commands like astro add, astro check
yarn astro -- --help	Get help using the Astro CLI

Resources

For help with Astro, check out the documentation or jump into Astro's Discord server. For help with Netlify, visit the Netlify documentation or Netlify's community forums.