Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 5.37 KB

README.md

File metadata and controls

101 lines (63 loc) · 5.37 KB
Raw

👉 Visit the DatoCMS homepage or see What is DatoCMS?

Nuxt Starter Kit

This project aims to be a great starting point for your Nuxt projects that need to interact with DatoCMS.

  • 🔍 Fully commented code — Every file is commented and explained in detail, it will be impossible to get lost!
  • 💯 100% TypeScript — Thanks to gql.tada every GraphQL query is fully typed, and your IDE will help you complete the GraphQL queries.
  • 🛠️ Minimal boilerplate — The project is minimal and exposes only what is necessary to get started, without complicated models that need to be removed.
  • 🚫 Zero CSS — There is only one CSS import, which you can remove to use your preferred CSS tool.
  • 📝 Full support for Draft Mode — Your editors can always view the latest draft version of the content.
  • 🧩 Plugin ready — Support for the fantastic plugins Web Previews and SEO/Readability Analysis.
  • 🔄 DatoCMS's Real-time Updates API — Your editors can see updated content instantly as soon as you save a new version on DatoCMS.
  • 🌐 SEO Metadata — Full integration between Nuxt and the SEO settings coming from DatoCMS.

How to use

Quick start

  1. Create an account on DatoCMS.

  2. Make sure that you have set up the Github integration on Vercel.

  3. Let DatoCMS set everything up for you clicking this button below:

Deploy with DatoCMS

Local setup

Once the setup of the project and repo is done, clone the repo locally.

Set up environment variables

Copy the sample .env file:

cp .env.local.example .env.local

In your DatoCMS' project, go to the Settings menu at the top and click API tokens.

Copy the values of the following tokens into the specified environment variable:

  • NUXT_PUBLIC_DATOCMS_PUBLISHED_CONTENT_CDA_TOKEN: CDA Only (Published)
  • NUXT_DATOCMS_DRAFT_CONTENT_CDA_TOKEN: CDA Only (Draft)
  • NUXT_DATOCMS_CMA_TOKEN: CMA Only (Admin)

Then set both NUXT_SECRET_API_TOKEN and NUXT_SIGNED_COOKIE_JWT_SECRET as a sicure strings:

  • The NUXT_SECRET_API_TOKEN will be used to safeguard all API routes from incoming requests from untrusted sources;
  • The NUXT_SIGNED_COOKIE_JWT_SECRET will be used to sign the Draft Mode cookies.

Run your project locally

npm install
npm run dev

Your website should be up and running on http://localhost:3000!

VS Code

It is highly recommended to follow these instructions for an optimal experience with Visual Studio Code, including features like diagnostics, auto-completions, and type hovers for GraphQL.

What is DatoCMS?

DatoCMS is the REST & GraphQL Headless CMS for the modern web.

Trusted by over 25,000 enterprise businesses, agency partners, and individuals across the world, DatoCMS users create online content at scale from a central hub and distribute it via API. We ❤️ our developers, content editors and marketers!

Quick links:

Our featured repos:

Or see all our public repos