https://github.com/nazaire/nuxt-netlify-cms-backend-module

A nuxt.js module that implements a backend server for Netlify CMS
https://github.com/nazaire/nuxt-netlify-cms-backend-module

Last synced: 22 days ago
JSON representation

A nuxt.js module that implements a backend server for Netlify CMS

• Host: GitHub
• URL: https://github.com/nazaire/nuxt-netlify-cms-backend-module
• Owner: Nazaire
• Created: 2020-03-01T09:55:02.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-27T02:09:59.000Z (about 2 years ago)
• Last Synced: 2024-11-16T08:15:18.320Z (3 months ago)
• Language: TypeScript
• Size: 113 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# nuxt-netlify-cms-backend-module

A nuxt.js module that implements a backend server for Netlify CMS.

This module runs a file storage proxy server that Netlify CMS can use as a backend. It installs [Netlify CMS Proxy Server](https://www.npmjs.com/package/netlify-cms-proxy-server) as server middleware so it can be easily installed as a nuxt module.

**Not maintained. Use as you wish.**

### Install

```

npm install git+https://github.com/Nazaire/nuxt-netlify-cms-backend-module.git

```

```

//nuxt.config.js

/*

 ** Nuxt.js modules

 */

modules: [ 

  ...

  'nuxt-netlify-cms-backend-module'

  ...

],

/*

 ** cms backend configuration (optional)

 */

cms: {

  path: '/admin' // This is the default path, if you change this don't forget to change backend.proxy_url in your config.yml

},

```

Done! The cms backend runs at /admin/api/v1 by default.  

**You need to add auth middleware that protect the api yourself.**

### Setup

Point netlify CMS to the backend api

```

//config.yml

backend:

  name: proxy

  proxy_url: /admin/api/v1

  

 ...

```

 

 ## Using your content

 

 ### Configuring Netlify CMS

 

 The most common installation of netlify CMS is creating an admin folder in /static/admin that contain the index.html and config.yml. [See Netlify's guide.](https://www.netlifycms.org/docs/nuxt/)

 

 Whatever paths you specify in your config.yml is where the content will be stored.

 

 ### Nuxtent

 I recommend installing [nuxtent](https://github.com/nuxt-community/nuxtent-module) which provides a plugin you can use to access your CMS content.

 

 These templates were a good reference: https://github.com/nuxt-community/nuxtent-module/tree/master/examples

 

 Expose your content in the nuxtent.config.js file, and use the $content plugin to fetch your content. [Example.](https://nuxtent-module.netlify.com/guide/usage/)