Git Product home page Git Product logo

nuxt-netlify-cms-starter's Introduction

๐Ÿž Nuxt & Netlify CMS Starter

A lot of the starter repos for Nuxt x Netlify CMS use a module like nuxtent or nuxtdown to manage flat file content. This project is meant to be a solution for those who don't mind doing a little more configuration to not have to rely on these dependencies.

๐ŸŽ‰ Getting Started

The quickest way to get started is with Netlify's hyper-convenient one-click Deploy To Netlify, which will automatically create an instance of this project on your GitHub account and deploy it instantly to Netlify.

Deploy to Netlify

Otherwise, you can follow these steps!

  1. ๐Ÿ‘ฏโ€โ™‚๏ธ Clone the repository locally and cd into the directory.
git clone https://github.com/xdesro/nuxt-netlify-cms-starter

cd nuxt-netlify-cms-starter
  1. ๐Ÿ“ฆ Install dependencies.
yarn install
  1. ๐Ÿ— Run the project for local dev. This will start a hot-reloading server at localhost:3000.
yarn dev
  1. ๐ŸŒŒ Build the app for server-side rendered deployment. See more about Universal SSR in the Nuxt.js docs.
yarn build

# And to serve that deployment...
yarn start
  1. โšก๏ธ Generate a fully pre-rendered static site. See more in the docs.
yarn generate

This project was bootstrapped with create-nuxt-app. There are more detailed explanations of how everything works in the Nuxt.js docs.

๐Ÿ–‹ Activating Netlify CMS

This project comes with Netlify CMS ready to rumble, and a basic blog configuration. To use Netlify CMS:

๐Ÿ” Authenticating with Netlify Identity

  1. Deploy to Netlify at least once.
  2. Go to Settings > Identity, and select Enable Identity service.
  3. Once enabled, select Settings and usage, and scroll down to Registration preferences. You can set this to either Open or Invite only, but usually Invite only is your best bet for a personal site.
  4. If you don't want to create an account, or would like to use an external provider such as GitHub or Google, you can enable those services under External providers.
  5. Scroll down to Services and click Enable Git Gateway.

๐Ÿ” Local Setup

  1. In your browser, navigate to localhost:3000/admin.
  2. Enter the Netlify URL of your site when prompted.
  3. Login with the account you created or one of the external providers, if you enabled them.

๐Ÿ’โ€โ™€๏ธ Questions? Concerns?

Feel free to reach out on Twitter. Friendly feedback and advice is always welcome. Contributions doubly so.

nuxt-netlify-cms-starter's People

Contributors

xdesro avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.