This repository has been archived by the owner on Jun 27, 2024. It is now read-only.
generated from sanity-io/sanity-template-vercel-visual-editing
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove upstream template repo readme contents and replace with basic description Signed-off-by: Matt Anderson <[email protected]>
- Loading branch information
Showing
1 changed file
with
3 additions
and
155 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,157 +1,5 @@ | ||
| # Vercel Visual Editing Demo<!-- omit in toc --> | ||
| # Datum + Sanity | ||
|
|
||
| ## [Live demo](https://sanity-template-vercel-visual-editing-git-preview.sanity.build/) | ||
| This repo holds a small page with a form for registering for a marketing newsletter. For information regarding the underlying template repository used, see the [upstream]. | ||
|
|
||
| > **Note** | ||
| > | ||
| > [Vercel Visual Editing][visual-editing] is available on [Vercel's Pro and Enterprise plans][vercel-enterprise] and on all Sanity plans. | ||
| This starter is preconfigured to support [Visual Editing][visual-editing-intro], a new feature that enables you to make changes using Vercel's draft mode and new edit functionality. It is a statically generated personal website that uses [Next.js][nextjs] for the frontend and [Sanity][sanity-homepage] to handle its content. | ||
|
|
||
| It comes with a native Sanity Studio that offers features like real-time collaboration, instant side-by-side content previews, and intuitive editing. | ||
|
|
||
| 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 personal website to learn more about Visual Editing or other awesome Sanity features. | ||
|
|
||
| [][vercel-deploy] | ||
|
|
||
| ## Features | ||
|
|
||
| - A performant, static personal personal website with editable projects | ||
| - A native and customizable authoring environment, accessible on `yourpersonalwebsite.com/studio` | ||
| - Real-time and collaborative content editing with fine-grained revision history | ||
| - Support for block content and the most advanced custom fields capability in the industry | ||
| - Free Sanity project with unlimited admin users, free content updates, and pay-as-you-go for API overages | ||
| - A project with starter-friendly and not too heavy-handed TypeScript and Tailwind.css | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Features](#features) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Project Overview](#project-overview) | ||
| - [Important files and folders](#important-files-and-folders) | ||
| - [Configuration](#configuration) | ||
| - [Step 1. Set up the environment](#step-1-set-up-the-environment) | ||
| - [Step 2. Set up the project locally](#step-2-set-up-the-project-locally) | ||
| - [Step 3. Run Next.js locally in development mode](#step-3-run-nextjs-locally-in-development-mode) | ||
| - [Step 4. Deploy to production](#step-4-deploy-to-production) | ||
| - [Questions and Answers](#questions-and-answers) | ||
| - [It doesn't work! Where can I get help?](#it-doesnt-work-where-can-i-get-help) | ||
| - [How can I remove the "Next steps" block from my personal site?](#how-can-i-remove-the-next-steps-block-from-my-personal-site) | ||
| - [Next steps](#next-steps) | ||
|
|
||
| ## Project Overview | ||
|
|
||
| | [Personal Website](https://template-vercel-visual-editing.sanity.build) | [Studio](https://template-vercel-visual-editing.sanity.build/studio) | | ||
| | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | ||
| |  |  | | ||
|
|
||
| ### Important files and folders | ||
|
|
||
| | File(s) | Description | | ||
| | ------------------------------------------- | ------------------------------------------------------- | | ||
| | `sanity.config.ts` | Config file for Sanity Studio | | ||
| | `sanity.cli.ts` | Config file for Sanity CLI | | ||
| | `/pages/studio/[[...index]]/page.tsx` | Where Sanity Studio is mounted | | ||
| | `/schemas` | Where Sanity Studio gets its content types from | | ||
| | `/plugins` | Where the advanced Sanity Studio customization is setup | | ||
| | `/lib/sanity.api.ts`,`/lib/sanity.image.ts` | Configuration for the Sanity Content Lake client | | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Step 1. Set up the environment | ||
|
|
||
| Use the Deploy Button below. It will let you deploy the starter using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-sanity-example) as well as connect it to your Sanity Content Lake using [the Sanity Vercel Integration][integration]. | ||
|
|
||
| [][vercel-deploy] | ||
|
|
||
| ### Step 2. Set up the project locally | ||
|
|
||
| [Clone the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) that was created for you on your GitHub account. Once cloned, run the following command from the project's root directory: | ||
|
|
||
| ```bash | ||
| npx vercel link | ||
| ``` | ||
|
|
||
| Download the environment variables needed to connect Next.js and the Studio to your Sanity project: | ||
|
|
||
| ```bash | ||
| npx vercel env pull | ||
| ``` | ||
|
|
||
| ### Step 3. Run Next.js locally in development mode | ||
|
|
||
| ```bash | ||
| npm install && npm run dev | ||
| ``` | ||
|
|
||
| When you run this development server, the changes you make in your frontend and studio configuration will be applied live using hot reloading. | ||
|
|
||
| Your personal website should be up and running on [http://localhost:3000][localhost-3000]! You can create and edit content on [http://localhost:3000/studio][localhost-3000-studio]. | ||
|
|
||
| ### Step 4. Deploy to production | ||
|
|
||
| To deploy your changes to production you use `git`: | ||
|
|
||
| ```bash | ||
| git add . | ||
| git commit | ||
| git push | ||
| ``` | ||
|
|
||
| Alternatively, you can deploy without a `git` hosting provider using the Vercel CLI: | ||
|
|
||
| ```bash | ||
| npx vercel --prod | ||
| ``` | ||
|
|
||
| ## Questions and Answers | ||
|
|
||
| ### How do I enable Visual Editing on my own Vercel project? | ||
|
|
||
| [Read our guide.][visual-editing] | ||
|
|
||
| ### It doesn't work! Where can I get help? | ||
|
|
||
| In case of any issues or questions, you can post: | ||
|
|
||
| - [GitHub Discussions for Next.js][vercel-github] | ||
| - [Sanity's GitHub Discussions][sanity-github] | ||
| - [Sanity's Community Slack][sanity-community] | ||
|
|
||
| ### How can I remove the "Next steps" block from my personal website? | ||
|
|
||
| You can remove it by deleting the `IntroTemplate` component in `/components/shared/Layout.tsx` and | ||
| the `/intro-template` directory. | ||
|
|
||
| ## Next steps | ||
|
|
||
| - [Join our Slack community to ask questions and get help][sanity-community] | ||
| - [How to edit my content structure?][sanity-schema-types] | ||
| - [How to query content?][sanity-groq] | ||
| - [What is content modelling?][sanity-content-modelling] | ||
|
|
||
| [vercel-deploy]: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsanity-io%2Fsanity-template-vercel-visual-editing&project-name=sanity-template-vercel-visual-editing&repository-name=sanity-template-vercel-visual-editing&demo-title=Visual%20Editing%20Demo&demo-description=A%20Sanity-powered%20personal%20website%20that%20showcases%20Visual%20Editing%20on%20Vercel.&demo-url=https%3A%2F%2Ftemplate-vercel-visual-editing.sanity.build%2F&demo-image=https%3A%2F%2Fuser-images.githubusercontent.com%2F81981%2F235943631-9c0cd33b-6534-4f82-98f3-641f72970590.png&integration-ids=oac_hb2LITYajhRQ0i4QznmKH7gx&external-id=nextjs;template=sanity-template-vercel-visual-editing | ||
| [integration]: https://www.sanity.io/docs/vercel-integration?utm_source=github.com&utm_medium=referral&utm_campaign=nextjs-v3vercelstarter | ||
| [`.env.local.example`]: .env.local.example | ||
| [nextjs]: https://github.com/vercel/next.js | ||
| [sanity-create]: https://www.sanity.io/get-started/create-project?utm_source=github.com&utm_medium=referral&utm_campaign=nextjs-v3vercelstarter | ||
| [sanity-deployment]: https://www.sanity.io/docs/deployment?utm_source=github.com&utm_medium=referral&utm_campaign=nextjs-v3vercelstarter | ||
| [sanity-homepage]: https://www.sanity.io?utm_source=github.com&utm_medium=referral&utm_campaign=nextjs-v3vercelstarter | ||
| [sanity-community]: https://slack.sanity.io/ | ||
| [sanity-schema-types]: https://www.sanity.io/docs/schema-types?utm_source=github.com&utm_medium=referral&utm_campaign=nextjs-v3vercelstarter | ||
| [sanity-github]: https://github.com/sanity-io/sanity/discussions | ||
| [sanity-groq]: https://www.sanity.io/docs/groq?utm_source=github.com&utm_medium=referral&utm_campaign=nextjs-v3vercelstarter | ||
| [sanity-content-modelling]: https://www.sanity.io/docs/content-modelling?utm_source=github.com&utm_medium=referral&utm_campaign=nextjs-v3vercelstarter | ||
| [sanity-webhooks]: https://www.sanity.io/docs/webhooks?utm_source=github.com&utm_medium=referral&utm_campaign=nextjs-v3vercelstarter | ||
| [localhost-3000]: http://localhost:3000 | ||
| [localhost-3000-studio]: http://localhost:3000/studio | ||
| [vercel]: https://vercel.com | ||
| [vercel-github]: https://github.com/vercel/next.js/discussions | ||
| [app-dir]: https://beta.nextjs.org/docs/routing/fundamentals#the-app-directory | ||
| [visual-editing]: https://www.sanity.io/docs/vercel-visual-editing?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch | ||
| [visual-editing-intro]: https://www.sanity.io/blog/visual-editing-sanity-vercel?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch | ||
| [sales-cta]: https://www.sanity.io/contact/sales?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch | ||
| [enterprise-cta]: https://www.sanity.io/enterprise?utm_source=github.com&utm_medium=referral&utm_campaign=may-vercel-launch | ||
| [vercel-enterprise]: https://vercel.com/docs/accounts/plans/enterprise | ||
| This starter was originally preconfigured to support Visual Editing, a new feature that enables you to make changes using Vercel's draft mode and new edit functionality. It is a statically generated personal website that uses Next.js for the frontend and Sanity to handle its content. |