Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milewskibogumil/astro-sanity-turborepo-starter
⚡️ Kickstart your web projects with the Astro + Sanity + Turbopack Starter! Integrate Astro, Sanity CMS, and Turbopack for high performance, Core Web Vitals optimization, and SEO-friendly web development. Perfect for building modern, fast, and flexible web applications with ease.
https://github.com/milewskibogumil/astro-sanity-turborepo-starter
astro astrojs cicd github-actions monorepo portable-text preview-deploy sanity sanity-io sanity-studio sanitycms seo seo-optimization starter-template turbo turborepo typescript
Last synced: about 1 month ago
JSON representation
⚡️ Kickstart your web projects with the Astro + Sanity + Turbopack Starter! Integrate Astro, Sanity CMS, and Turbopack for high performance, Core Web Vitals optimization, and SEO-friendly web development. Perfect for building modern, fast, and flexible web applications with ease.
- Host: GitHub
- URL: https://github.com/milewskibogumil/astro-sanity-turborepo-starter
- Owner: milewskibogumil
- Created: 2024-09-13T13:22:32.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-18T13:21:46.000Z (2 months ago)
- Last Synced: 2024-10-19T05:31:24.725Z (2 months ago)
- Topics: astro, astrojs, cicd, github-actions, monorepo, portable-text, preview-deploy, sanity, sanity-io, sanity-studio, sanitycms, seo, seo-optimization, starter-template, turbo, turborepo, typescript
- Language: TypeScript
- Homepage:
- Size: 415 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Astro + Sanity + Turborepo Starter
⚡️ Kickstart your web projects with the [Astro](https://astro.build/) + [Sanity](https://www.sanity.io/) + [Truborepo](https://turbo.build/) Starter! Integrate Astro, Sanity, and Turborepo for high performance, Core Web Vitals optimization, and SEO-friendly web development. Perfect for building modern, fast, and flexible web applications with ease.
## Features
- **Portable Text**: Flexible rich text handling with customizable structures.
- **Type Safety**: TypeScript support throughout the project.
- **SEO Optimization**: Dynamic metadata fetching and SEO-friendly URLs.
- **Sanity Integration**: Seamless content management with Sanity CMS.
- **Error Handling**: Robust error management in metadata and content fetching.
- **Customizable Components**: Flexibility in rendering text and links.
- **Development Tools**: Integrated ESLint, Prettier, and TypeScript for high code quality.
- **Preview Functionality**: Fast content preview and internal linking within Sanity.
- **Singleton Types & Validation**: Ensures data integrity and easy management of global settings.
## Advantages
- **Performance**: Fast builds and efficient development with Turborepo.
- **Type Safety**: Comprehensive TypeScript integration for reliable code.
- **SEO-Ready**: Built-in optimizations for improved SEO performance.
- **Seamless Integration**: Smooth content management with Sanity.
- **Customizability**: Extensible components and flexible Portable Text configuration.
- **CI/CD**: Automated Sanity deployments with GitHub Actions.
## Setup Instructions
### 1. Environment Variables
Set the following environment variables for local or production setups:
**Sanity Studio Preview**
In the `/apps/sanity` directory, create a `.env.local` file with:
```
SANITY_STUDIO_PREVIEW_DOMAIN=
```
**Astro API Token**
In the `/apps/astro` directory, create a `.env.local` file with:
```
SANITY_API_TOKEN=
```
_Generate this token in your Sanity project dashboard._
### 2. Constant Files
Update `constants.ts` in both `/apps/sanity/constants.ts` and `/apps/astro/src/global/constants.ts` directories to match your project settings.
### 3. Project ID
Update the `projectId` in:
- `/apps/astro/src/utils/sanity.fetch.ts`
- `/apps/sanity/sanity.cli.ts`
- `/apps/sanity/sanity.config.ts`
_Ensure these IDs correspond to your Sanity project._
### 4. GitHub Actions
To automatically deploy the Sanity Studio:
- **Deployment Trigger**: Automatic deployment occurs when you push changes to any file within the `/apps/sanity/*` directory.
- **Required Environment Variables**:
- `SANITY_DEPLOY_STUDIO_TOKEN`: Add this token to your GitHub project's environment variables for deployment.
- `SANITY_STUDIO_PREVIEW_DOMAIN`: Set this variable for your preview deployment domain in Sanity Studio.
## Authors
- [@milewskibogumil](https://github.com/milewskibogumil)