## Configuration
### Step 1. Create an account and a project on Sanity
First, [create an account on Sanity](https://sanity.io).
After creating an account, install the Sanity cli from npm `npm i -g @sanity/cli`.
### Step 2. Create a new Sanity project
In a separate folder run `sanity init` to initialize a new studio project.
This will be where we manage our data.
When going through the init phase make sure to select **Yes** to the **Use the default dataset configuration** step and select **Clean project with no predefined schemas** for the **Select project template** step.
### Step 3. Generate an API token
Log into https://manage.sanity.io/ and choose the project you just created. Then from **Settings**, select **API**, then click **Add New Token** and create a token with the **Read** permission.
### Step 4. Set up environment variables
Copy the `.env.local.example` file in this directory to `.env.local` (which will be ignored by Git):
```bash
cp .env.local.example .env.local
Then set each variable on .env.local
:
NEXT_PUBLIC_SANITY_PROJECT_ID
should be theprojectId
value from thesanity.json
file created in step 2.NEXT_PUBLIC_SANITY_DATASET
should be thedataset
value from thesanity.json
file created in step 2 - defaults toproduction
if not set.SANITY_API_TOKEN
should be the API token generated in the previous step.SANITY_PREVIEW_SECRET
can be any random string (but avoid spaces), likeMY_SECRET
- this is used for Preview Mode.
Your .env.local
file should look like this:
NEXT_PUBLIC_SANITY_PROJECT_ID=...
NEXT_PUBLIC_SANITY_DATASET=...
SANITY_API_TOKEN=...
SANITY_PREVIEW_SECRET=...
Go to https://www.sanity.io/docs/preview-content-on-site and follow the three steps on that page. It should be done inside the studio project generated in Step 2.
When you get to the second step about creating a file called resolveProductionUrl.js
, copy the following instead:
const previewSecret = 'MY_SECRET' // Copy the string you used for SANITY_PREVIEW_SECRET
const projectUrl = 'http://localhost:3000'
export default function resolveProductionUrl(document) {
return `${projectUrl}/api/preview?secret=${previewSecret}&slug=${document.slug.current}`
}
After initializing your Sanity studio project there should be a schemas
folder.
Replace the contents of schema.js
in the Sanity studio project directory with ./schemas/schema.js
in this example directory. This will set up the schema we’ll use this for this example.
To add some content go to your Sanity studio project directory and run sanity start
.
After the project has started and you have navigated to the URL given in the terminal, select Author and create a new record.
- You just need 1 Author record.
- Use dummy data for the text.
- For the image, you can download one from Unsplash.
Next, select Post and create a new record.
- We recommend creating at least 2 Post records.
- Use dummy data for the text.
- You can write markdown for the Content field.
- For the images, you can download ones from Unsplash.
- Pick the Author you created earlier.
Important: For each post record, you need to click Publish after saving. If not, the post will be in the draft state.
npm install
npm run dev
# or
yarn install
yarn dev
Your blog should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.
On Sanity, go to one of the posts you've created and:
- Update the title. For example, you can add
[Draft]
in front of the title. - As you edit the document it will be saved as a draft, but DO NOT click Publish. By doing this, the post will be in the draft state.
Now, if you go to the post page on localhost, you won't see the updated title. However, if you use the Preview Mode, you'll be able to see the change (Documentation).
To view the preview, go to the post edit page on Sanity, click the three dots above the document and select Open preview (see the instruction here)
You should now be able to see the updated title. To exit Preview Mode, you can click on "Click here to exit preview mode" at the top.