Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
config
src
.dockerignore
.gitignore
README.md
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

Paperboy

Content Delivery Layer

Installation

$ npm add @neoskop/paperboy

Configuration

There are two ways to overwerite the default configuration:

  • Overwrite the default configuration by adding a config/default.json file to your project.
  • Use the options argument of the generate function.

Usage Example

import { generate } from '@neoskop/paperboy';
 
generate('magnolia', { output: { assets: 'output/assets', json: 'output' } })
    .then(() => {
      console.log('Success');
    }).catch(() => {
      console.log('Error');
    });

##Development

Build and start the project for development:

Requirement

  • Node >= 8.9.1

Install

$ npm i

Start

Builds and starts the project with nodemon and watcher.

$ npm start

Build

Builds the project (dist directory).

$ npm run build

Release

Make sure to build and commit before releasing.

$ npm version patch|minory|major
$ npm publish
You can’t perform that action at this time.