Astro Quickstart Template

This is a bare-bones Astro project that has everything you need to quickly deploy it to Netlify.

Hate reading, here's a video: https://youtu.be/SknFflQVOys!

Love reading, here's blog post: www.netlify.app/blog/deploy-your-astro-project-fast/!

Table of Contents:

• Quick Setup + Deploy Option
• Regular Setup
  • Cloning + Install Packages
  • Deploying
• Astro + Netlify Resources
• Project Structure
• Styling
  • Notes on Styling
  • Remove Styling
• Commands
• Testing
  • Included Default Testing
  • Removing Renovate
  • Removing Cypress
• Want to learn more?

Quick Setup + Deploy Option

Click this button and it will help you create a new repo, create a new Netlify project, and deploy!

Regular Setup

1. Cloning + Install Packages

• Clone this repo with one of these options:

  • Click the 'Use this template' button at the top of the page
  • Or via the command line git clone https://github.com/netlify-templates/astro-quickstart

• Then install the necessary packages and run the project locally to make sure everything works.

  npm install
  npm run dev

Alternatively, you can run this locally with the Netlify CLI's by running the netlify dev command for more options like receiving a live preview to share (netlify dev --live) and the ability to test Netlify Functions and redirects.

2. Deploying

• Install the Netlify CLI globally npm install netlify-cli -g

• Run npm run build

• Then use the netlify deploy for a deploy preview link or netlify deploy --prod to deploy to production

Here are a few other ways you can deploy this template:

• Use the Netlify CLI's create from template command netlify sites:create-template astro-quickstart which will create a repo, Netlify project, and deploy it

• If you want to utilize continuous deployment through GitHub webhooks, run the Netlify command netlify init to create a new project based on your repo or netlify link to connect your repo to an existing project

Astro + Netlify Resources

Here are some resources to help you on your Astro + Netlify coding fun!

• Astro on Netlify Integration Page

• Build wicked fast sites with Astro: An Introduction

• A Template for Building Shopify Stores with Astro and the Storefront API

Hope this template helps :) Happy coding 👩🏻‍💻!

---

Project Structure

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

/
├── public/
│   └── favicon.ico
├── src/
│   ├── components/
│   │   └── Layout.astro
│   ├── pages/
│   │   └── index.astro
│   └── style/
│       └── demo-styling.css
└── 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 or layouts.

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

Styling

We've added some modern styling to this template using css within an external stylesheet, this will allow you to easily remove our styling and add in your own.

If you decide that you want to keep our styling you can review our style notes below.

Notes on Styling

The variables below give you the ability to change the gradient colors of the blobs and are interpolated into the URL string of the background-img within the body.

// Controls the blob blur gradient colors within the main tag's svg
--top-right-blur-1: #20C6B7;
--top-right-blur-2: #4D9ABF;
--bttm-left-blur-1: #FF5C02;
--bttm-left-blur-2: #FFCDB1;

Remove Styling

If you decide that our styling is not for you, all you'll need to do is remove the demo-styling.css file.

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

Testing

Included Default Testing

We’ve included some tooling that helps us maintain these templates. This template currently uses:

• Renovate - to regularly update our dependencies
• Cypress - to run tests against how the template runs in the browser
• Cypress Netlify Build Plugin - to run our tests during our build process

If your team is not interested in this tooling, you can remove them with ease!

Removing Renovate

In order to keep our project up-to-date with dependencies we use a tool called Renovate. If you’re not interested in this tooling, delete the renovate.json file and commit that onto your main branch.

Removing Cypress

For our testing, we use Cypress for end-to-end testing. This makes sure that we can validate that our templates are rendering and displaying as we’d expect. By default, we have Cypress not generate deploy links if our tests don’t pass. If you’d like to keep Cypress and still generate the deploy links, go into your netlify.toml and delete the plugin configuration lines:

[[plugins]]
  package = "netlify-plugin-cypress"
-  [plugins.inputs.postBuild]
-    enable = true
-
-  [plugins.inputs]
-    enable = false 

If you’d like to remove the netlify-plugin-cypress build plugin entirely, you’d need to delete the entire block above instead. And then make sure sure to remove the package from the dependencies using:

npm uninstall -D netlify-plugin-cypress

And lastly if you’d like to remove Cypress entirely, delete the entire cypress folder and the cypress.config.ts file. Then remove the dependency using:

npm uninstall cypress

Want to learn more?

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

Self-Hosting TinaCMS

We'll self-host TinaCMS on Netlify, using a serverless function as the GraphQL API. To start, set the following environment variables in your .env:

Variable	Description
GITHUB_BRANCH	The name of the branch where the content will be stored
GITHUB_OWNER	User account or organization that owns the GitHub repo
GITHUB_REPO	Name of the GitHub repo
GITHUB_PERSONAL_ACCESS_TOKEN	GitHub personal access token
TINA_PUBLIC_IS_LOCAL	If true TinaCMS will run locally. If false content will be committed to GitHub
MONGODB_NAME	MongoDB database name
MONGODB_URI	MongoDB connection string
NEXTAUTH_SECRET	Random string to serve as authentication secret

Install Netlify CLI

npm install netlify-cli -g

Start Development Server

netlify dev

Cloudinary

Self-hosted TinaCMS does not support Git backed media. We'll need to use the Cloudinary integration in order to use the media manager. To do so, set the following environment variables:

CLOUDINARY_CLOUD_NAME
CLOUDINARY_API_KEY
CLOUDINARY_API_SECRET