Have ideas to improve npm?Join in the discussion! »

    simplicite

    1.1.22 • Public • Published

    Simplicité Software


    Author License Gitter chat

    Quality Gate Status

    Simplicité® node.js® & browser JavaScript API

    NPM

    Introduction

    This is the node.js® & browser JavaScript API for the Simplicité® platform.

    It can be used in server-side node applications, in a client-side web applications (e.g. by building a bundle with browserify and/or by using various dedicated frameworks) or in native JavaScript-based mobile frameworks.

    Note: for browser compatibility reasons this module is implemented in ES5

    Install

    npm install

    Usage

    See the documentation for details.

    Test

    Set the environment variables for your Simplicité instance:

    • TEST_SIMPLICITE_SCHEME defaults to 'http'
    • TEST_SIMPLICITE_HOST defaults to 'localhost'
    • TEST_SIMPLICITE_PORT defaults to 8080
    • TEST_SIMPLICITE_ROOT defaults to '' (root webapp)
    • TEST_SIMPLICITE_URL defaults to http://localhost:8080
    • TEST_SIMPLICITE_ADMIN_SERNAME defaults to 'designer'
    • TEST_SIMPLICITE_ADMIN_PASSWORD defaults to 'designer'
    • TEST_SIMPLICITE_USERNAME defaults to 'website'
    • TEST_SIMPLICITE_PASSWORD defaults to 'simplicite'

    Run the unit tests, this generates the coverage folder:

    npm run test

    Build

    Check syntax and rules:

    npm run lint

    Generates the minified dist/simplicite.min.js file:

    npm run build

    Documentation

    Generate documentation:

    npm run doc

    Publish

    Publish to npm repository:

    npm publish

    License

    Copyright Simplicité Software

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    Install

    npm i simplicite

    DownloadsWeekly Downloads

    41

    Version

    1.1.22

    License

    Apache-2.0

    Unpacked Size

    142 kB

    Total Files

    11

    Last publish

    Collaborators

    • avatar
    • avatar