Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/treefarmstudio/astro-sanity-minimal-starter
https://github.com/treefarmstudio/astro-sanity-minimal-starter
astro sanity sanity-io starter
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/treefarmstudio/astro-sanity-minimal-starter
- Owner: treefarmstudio
- License: mit
- Created: 2021-08-10T04:51:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-15T16:38:04.000Z (over 2 years ago)
- Last Synced: 2024-04-16T17:25:30.531Z (10 months ago)
- Topics: astro, sanity, sanity-io, starter
- Language: Astro
- Homepage: https://astro-sanity-minimal-starter.netlify.app/
- Size: 5.63 MB
- Stars: 99
- Watchers: 3
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Astro Sanity Minimal Starter
## [Demo Site](https://astro-sanity-minimal-starter.netlify.app/)
If you haven't heard about [Astro](https://astro.build) yet you're missing out. This starter repo gives you a blog website with a headless CMS setup using [Sanity.io](https://sanity.io).
Don't be fooled by the simplicity of this starter either. With excellent SEO built in, Astro's excellent developer environment, and performance best practices you're getting one of the best foundations for a personal blog with posts written in markdown. The reason for making such a bare bones starter in terms of styles is that it has what you need out of the box for SEO and site structure but it makes no assumptions about how you want it look and behave.
Sometimes starters can feel like they are giving us way too much and you'll spend a day picking apart half of the code to get to the setup you actually wanted. Want to use vanilla CSS instead of Tailwind or Scss? No problem!
## Features
- A customizable headless CMS with [Sanity.io](https://sanity.io)
- Excellent SEO Built In
- Open Graph Tags (Twitter, Facebook, etc.)
- User Declared Canonical URLs
- RSS Feed
- XML Sitemap
- Robots.txt
- JSON LD Schema
- Extremely minimal styles
- Performant Google Fonts Setup
## Get Started
Watch my [step-by-step tutorial on YouTube](https://youtu.be/-jAWLTfsSQw)
**Or**
Follow the manual steps below:
### Initial Sanity Setup
1. [Create a repo from this template](https://github.com/jaydanurwin/astro-sanity-minimal-starter/generate)
2. If you don't have the Sanity CLI already run `npm install -g @sanity/cli`
3. Open a terminal from root folder of the project
4. `cd sanity`
5. `sanity install`
6. `sanity init` and follow the prompts (you will need to create a Sanity account if you haven't already)
8. Navigate to the astro folder
7. Rename `.env.template` to `.env` and
8. Replace the PUBLIC_SANITY_PROJECT_ID value with your token ID
**Note:** You will want to add http://localhost:3000 to your allowed CORS orgins in your Sanity project settings at [https://manage.sanity.io](https://manage.sanity.io)
### To run your Sanity Studio
1. Open a terminal located at the sanity folder
2. `sanity install`
3. `sanity start`
4. Your studio should be running on [http://localhost:3333](http://localhost:3333)
5. Open [http://localhost:3333](http://localhost:3333) and copy the project ID from the Project info section
### To run your Astro site
1. Open a terminal located at the astro folder
2. `npm install`
3. `npm start`
4. Your Astro site should be running on [http://localhost:3000](http://localhost:3000)
5. `npm run build` to build to production locally