Files
payload/README.md
Elliot DeNolf 58dd42f73b Fix README
2018-05-02 21:58:36 -06:00

762 B

Payload

Headless CMS

Usage

const Payload = require('payload');

// Initialize class
const payload = new Payload({
  express: app,
  mongoose,
  baseURL: 'base123'
});

// Sample collection creation
let coolCollection = payload.newCollection('cool');
coolCollection.add({
  test: { testProp: 'one', testProp2: 'two' }
});
coolCollection.register();

// Retrieve collection
let retrievedCollection = payload.getCollection('cool');
console.log(`Retrieved ${retrievedCollection.key} collection`);
console.log(`testProp: ${coolCollection.fields.test.testProp}`);

// Add payload views
app.set('views', [`${__dirname}/views`, payload.views]);

Development

  • npm test to run test suite
  • npm run watch to run nodemon on the payload directory