Git Product home page Git Product logo

coal-js's Introduction

Coal-js

The JavaScript API Client for LocomotiveCMS V3 (WIP).

Installation

npm install coal-js

Usage

Client = require('./coal/client.js').Client;

const client = new Client({
  baseUrl: "https://station.locomotive.works/locomotive/api/v3",
  basicAuth: {
    username: "xxx",
    password: "xxx"
  }
  email: "[email protected]",
  apiKey: "a391c1669a73394d5840780fc940c05b1e12c36f"
});

// get engine version
client.getEngineVersion().then(({data}) => console.log(data.engine))

// get user name
client.getMyAccount().then(({data}) => console.log(data.name))

// get site handle
let handle;
client.getSites().then((response) => handle = response.data[0].handle)

// scope resources by site
client.scopedBySite(handle);

// get current site name
client.getCurrentSite().then(({data}) => console.log(data.name))

// get content type slug
let slug;
client.getContentTypes().then((response) => slug = response.data[0].slug)

// get content type entries
client.getContentTypeEntries(slug).then((response) => console.log(response.data))

NPM Scripts

# install dependencies
npm install

# run tests
npm run test

# run one single test
npm run test:single ./src/coal/client.test.js

# run tests and watches for file changes
npm run dev

# run tests and launch node-inspector to debug with chrome-devtools (https://medium.com/@paul_irish/debugging-node-js-nightlies-with-chrome-devtools-7c4a1b95ae27)
npm run debug

# build dist for production (ES5)
npm run build

Roadmap

  • POST /tokens.json
  • GET /version.json
  • GET /my_account.json
  • GET /sites.json
  • POST /sites.json
  • DELETE /sites.json/{id}
  • GET /current_site.json
  • GET /pages.json
  • GET /pages.json/{id}
  • POST /pages.json
  • PATCH /pages.json/{id}
  • DELETE /pages.json/{id}
  • GET /content_types.json
  • GET /content_types/{id}/entries.json
  • POST /content_entries.json
  • PATCH /content_entries.json/{id}
  • DELETE /content_entries.json/{id}

coal-js's People

Contributors

rgcunha 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.