/analog-sanity-blog

An Analog Blog with a Native Authoring Experience using Limitless Angular

Primary LanguageTypeScriptMIT LicenseMIT

Analog Sanity Blog

Screenshot of Sanity Studio using Presentation Tool to do Visual Editing

This starter is a statically generated blog example using Analog and Sanity, to handle its content. It comes with a native Sanity Studio that offers features like real-time collaboration and visual editing with live updates using Presentation and Limitless Angular.

The Studio connects to Sanity Content Lake, which gives you hosted content APIs with a flexible query language, on-demand image transformations, powerful patching, and more. You can use this starter to kick-start a blog or learn these technologies.

Features

  • A performant, static blog with editable posts, authors, and site settings
  • TypeScript setup with Sanity TypeGen
  • A native and customizable authoring environment, accessible on yourblog.com/studio
  • Real-time and collaborative content editing with fine-grained revision history
  • Side-by-side instant content preview that works across your whole site
  • Support for block content and the most advanced custom fields capability in the industry
  • Incremental Static Revalidation; no need to wait for a rebuild to publish new content
  • Unsplash integration setup for easy media management
  • Sanity AI Assist preconfigured for image alt text generation
  • Visual editing feature powered by Analog and Limitless Angular

Unique Features

  • Zone-free blog (not using zone.js)
  • Utilizes the latest Angular features, including signals and built-in control flow
  • Integration with Limitless Angular for enhanced Sanity.io integration

Demo

https://analog-sanity-blog.vercel.app

Deploy your own

Before deploying, follow these steps:

  1. Create a BYPASS_TOKEN Environment Variable to store a revalidation secret:

    • Use the command openssl rand -base64 32 or Generate a Secret to generate a random value.

  2. Click the deploy button below:

Deploy with Vercel

  1. In the Vercel UI, add the BYPASS_TOKEN secret you generated earlier.

How to use

Execute create-nx-workspace with npm, Yarn, or pnpm to bootstrap the example:

npx create-nx-workspace@latest analog-sanity-blog --preset=analog
yarn create nx-workspace analog-sanity-blog --preset=analog
pnpm create nx-workspace analog-sanity-blog --preset=analog

Whenever you edit a GROQ query you update the TypeScript types by running:

npm run typegen

Configuration

Step 1. Set up the environment

Reuse remote envionment variables

If you started with deploying your own then you can run this to reuse the environment variables from the Vercel project and skip to the next step:

npx vercel link
npx vercel env pull

Using the Sanity CLI

Copy the .env.local.example file to .env.local to get started:

cp .env.local.example .env.local

Run the setup command to get setup with a Sanity project, dataset and their relevant environment variables:

npm run setup
yarn setup
pnpm run setup

You'll be asked multiple questions, here's a sample output of what you can expect:

Need to install the following packages:
sanity@3.30.1
Ok to proceed? (y) y
You're setting up a new project!
We'll make sure you have an account with Sanity.io.
Press ctrl + C at any time to quit.

Prefer web interfaces to terminals?
You can also set up best practice Sanity projects with
your favorite frontends on https://www.sanity.io/templates

Looks like you already have a Sanity-account. Sweet!

✔ Fetching existing projects
? Select project to use Templates [r0z1eifg]
? Select dataset to use blog-vercel
? Select dataset to use production

Detected framework Vite, using prefix 'VITE_'
Found existing VITE_SANITY_PROJECT_ID, replacing value.
Found existing VITE_SANITY_DATASET, replacing value.

Creating a read token

This far your .env.local file should have values for VITE_SANITY_PROJECT_ID and VITE_SANITY_DATASET. Before you can run the project you need to setup a read token (SANITY_API_READ_TOKEN), it's used for authentication when Sanity Studio is live previewing your application.

  1. Go to manage.sanity.io and select your project.
  2. Click on the 🔌 API tab.
  3. Click on + Add API token.
  4. Name it "next blog live preview read token" and set Permissions to Viewer and hit Save.
  5. Copy the token and add it to your .env.local file.
SANITY_API_READ_TOKEN="<paste your token here>"

Your .env.local file should look something like this:

VITE_SANITY_PROJECT_ID="r0z1eifg"
VITE_SANITY_DATASET="blog-vercel"
SANITY_API_READ_TOKEN="sk..."

Caution

Make sure to add .env.local to your .gitignore file so you don't accidentally commit it to your repository.

Step 2. Run Analog locally in development mode

npm install && npm run dev:all
yarn install && yarn dev:all
pnpm -r --link-workspace-packages install && pnpm dev:all

Your blog should be up and running on http://localhost:4200! If it doesn't work, post on GitHub discussions.

Step 3. Populate content

Open your Sanity Studio that should be running on http://localhost:3333.

By default you're taken to the Presentation tool, which has a preview of the blog on the left hand side, and a list of documents on the right hand side.

View screenshot ✨

screenshot

We're all set to do some content creation!

  • Click on the "+ Create" button top left and select Post

  • Type some dummy data for the Title

  • Generate a Slug

    Now that you have a slug you should see the post show up in the preview on the left hand side ✨

    screenshot

  • Fill in Content with some dummy text

    Or generate it with AI Assist ✨

    If you've enabled AI Assist you click on the sparkles ✨ button and generate a draft based on your title and then on Generate sample content.

    screenshot

  • Summarize the Content in the Excerpt field

    Or have AI Assist summarize it for you ✨

    If you've enabled AI Assist you click on the sparkles ✨ button and then on Generate sample content.

    screenshot

  • Select a Cover Image from Unsplash.

    Unsplash is available in the **Select** dropdown ✨

    screenshot

    Click the "Crop image" button to adjust hotspots and cropping ✨

    screenshot

    You can preview the results live on the left side, and additional formats on the right side ✨

    screenshot

  • Customize the blog name, description and more.

    Click "Structure" at the top center, then on "Settings" on the left hand side ✨

    screenshot

    Once you have a "Settings" document, you can customize it inside "Presentation" ✨

    screenshot

Important

For each post record, you need to click Publish after saving for it to be visible outside Draft Mode. In production new content is using Route Rules to set a Time-based Revalidation, which means it may take up to 1 minute before changes show up. Since a stale-while-revalidate pattern is used you may need to refresh a couple of times to see the changes.

Step 4. Deploy to production

4.1 Deploy the Analog Blog

Note

If you already deployed with Vercel earlier you can skip this step.

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.

Important

When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.

After it's deployed link your local code to the Vercel project:

npx vercel link

Tip

In production you can exit Draft Mode by clicking on "Back to published" at the top. On Preview deployments you can toggle Draft Mode in the Vercel Toolbar.

4.2 Deploy the Sanity Studio

Before deploying the Sanity Studio, we need to set up the correct environment variables:

  1. Create a .env.production.local file in the root of your project if it doesn't exist already.

  2. Add the VITE_SANITY_PREVIEW_URL variable to this file, pointing to your deployed Analog blog URL:

VITE_SANITY_PREVIEW_URL=https://your-analog-blog-url.vercel.app

Note

The VITE_SANITY_PREVIEW_URL is used by the Sanity Studio to enable real-time preview of your content on your deployed Analog blog.

  1. Update your .env.local file with the Studio URL as defined in sanity.cli.ts:
VITE_SANITY_STUDIO_URL=https://analog-sanity-blog-your-project-id.sanity.studio

Replace your-project-id with your actual Sanity project ID.

Note

The VITE_SANITY_STUDIO_URL is used by your Analog blog to know where to find the Sanity Studio, enabling features like "Edit" buttons that link directly to the Studio.

Now, let's proceed with the deployment:

  1. Build the Sanity Studio:
nx build studio
  1. Deploy the built Studio to Sanity's servers:
nx deploy studio

  1. Once deployed, confirm that the Studio URL matches the one you've set in your .env.local file.

  2. Update your Vercel deployment with the new Studio URL environment variable:

npx vercel env add VITE_SANITY_STUDIO_URL
  1. Redeploy your Analog blog to Vercel to use the new environment variable:
npx vercel --prod

Now both your Analog blog and Sanity Studio are deployed and correctly connected in production. The Studio will be able to preview your Analog blog, and your blog will know where to find the Studio.

Next steps

License

This project is licensed under the MIT License. See our MIT file for details.