@namics/nitro-frontify-deployer

A helper to deploy all nitro components to frontify

Stats

StarsIssuesVersionUpdatedCreatedSize
@namics/nitro-frontify-deployer
000.0.175 years ago5 years agoMinified + gzip package size for @namics/nitro-frontify-deployer in KB

Readme

Nitro Frontify Deployer

npm version Build Status Build status Coverage Status Codestyle

This build tool generates all necessary artifacts to deploy the entire nitro project into frontify

Installation

npm i --save-dev @namics/nitro-frontify-deployer

Usage

const NitroFrontifyDeployer = new require('@namics/nitro-frontify-deployer');
const deployer = new NitroFrontifyDeployer({
    rootDirectory: '/path/to/your/components',
    // This mapping is used to resolve the component type from the folder name
    // e.g. component/atoms/button.js -> type: atom
    mapping: {
        'atoms': 'atom',
        'molecules': 'molecules',
        'helpers': 'atom'
    },
    // The example template compiler
    compiler: (template) => require('handlebars').compile(template),
    // Destination directory
    targetDir: '/path/to/your/dist/',
    // Frontify Options
    frontifyOptions: {
        access_token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        project: 12345,
        baseUrl: 'https://app.frontify.com/',
    }
});
// Validate, Build, Sync:
deployer.deploy();

Security

You can also pass the frontify access_token by setting a FRONTIFY_ACCESS_TOKEN process variable instead of writting it into your code.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.