Sanity
SaaSBold comes with a fully functional blog with Sanity. In this part of the documentation, we are going to show you how to integrate Sanity and enable blog into your SaaS Boilerplate.
Last updated
SaaSBold comes with a fully functional blog with Sanity. In this part of the documentation, we are going to show you how to integrate Sanity and enable blog into your SaaS Boilerplate.
Last updated
Integrating Sanity into your SaaSBold boilerplate allows you to manage and publish content easily. Sanity provides a powerful content management system (CMS) that integrates seamlessly with your application. This guide will walk you through the steps to set up Sanity, configure it, and publish content.
Follow the Step-by-Step Guide to Integrate Sanity:
Let's start our integration process by utilizing the Sanity project.
Initialize a Sanity project: Run this command in a separate directory/folder and follow the instructions on the command line to initialize a project.
Note: We don't need the project created with this command. It'll create the project on the Sanity dashboard. You can delete the project folder from the directory after the project shows up on sanity.io/manage
Get the Project Name and ID: To get the key, log in to Sanity.io/manage and go to the project you created earlier. When you go to the project, you’ll see Project Name and ID. Go ahead and copy it.
Add URL to Sanity Studio: Go to http://localhost:3000/studio to add the URL. You’ll be redirected to a page that looks like this. Go ahead and click on Continue. It’ll take you to your Sanity Projects Dashboard.
Click Continue to add the URL as CORS origin.
Log in to the Studio: To start writing, log in to the studio by visiting http://localhost:3000/studio. You’ll be redirected to a login page where you’ll see all the providers you can use to log in. Choose the provider you want to log in with.
After you’ve logged in, you’ll be redirected to Sanity Studio Dashboard. From the dashboard, you can post Articles and add Authors.
Now, let's explore how to create, write and publish your article using Sanity's dashboard.
Create a New Post: Click on the Post button, then the Create post icon, as shown below.
Write Your Article: Now write the article by adding all the required data like the Title, Metadata, and Tags.
3. Add Image: To add an image to the blog post article, click the "Image" button in the editor and choose "Image."
4. Publish: Once your article is ready, click the "Publish" button to publish the article.
If everything is done correctly, you’ll see the article on the Blog page.
To seamlessly fetch and display the blog posts on our website, we'll need an API key.
Get the API Key: Go to the API tab, then Tokens. After that, click on the Add API token button.
Fill in the form with the required information.
Name: Give a descriptive name to your API key.
Permission: Give the editor access Or Choose the access privileges for the token you want.
Now hit the save button.
After you hit the save button, you’ll get an API key. Copy the key and save it to the env file:
We used Sanity webhook for on-demand data revalidation.
Follow the steps to integrate webhook:
Create a webhook: Go to sanity/manage and navigate to the API tab, then click on the Create Webhook button
Fill in the form with information about the hook you want to create:
Name: Give your webhook a name.
Description: Describe the function of your webhook (This is an optional field).
URL: Set the URL to https://YOUR_SITE_URL/api/revalidate
Dataset: Choose your desired dataset or leave the default value.
Trigger on: Set the hook to trigger "Create", "Update", and "Delete".
Filter: Leave this field blank.
Projections: Set the projections to {_type, "slug": slug.current}
Status: Check the enable webhook box.
HTTP Method: POST.
HTTP headers: Leave HTTP headers, API version, and Draft as default.
API version: As default.
Drafts: Keep untick or Choose as you desired
Secret: Give your webhook a unique secret and copy it.
Hit save once completed to create your webhook.
Save your webhook in the .env file under this variable name of your live site. Note: you can’t test webhooks in the local environment.
real-timeTesting the webhook: Go ahead and change the content of an Article and publish it. After that, hard reload your website, and you should see the changes in real-time.
Note: You can’t test webhooks in the local environment.
Here are some additional tips to help you make the most of your Sanity integration:
Use Predefined Schemas: Leverage Sanity's predefined schemas to quickly set up content structures like posts, authors, and categories.
Customize the Studio: Sanity Studio is highly customizable. You can modify the layout, add custom input components, and tailor the interface to meet your specific needs.
Back-Up Regularly: Although Sanity is robust, it’s always a good practice to back up your content and configurations regularly.
Explore Plugins: Sanity has a rich ecosystem of plugins that can extend the functionality of your studio.
Stay Updated: Keep an eye on updates and new features released by Sanity. Regular updates can bring new capabilities and improvements.
By following these steps, you will successfully integrate Sanity into your SaaSBold boilerplate, enabling you to manage and publish blog content efficiently.
