Website JS Toolbox

Set of javascript tools and behaviors to use atop classical back applications.

Installation

npm install website-js-toolbox

yarn add website-js-toolbox

Usage

// Import as a Module
import * as WebsiteJsToolbox from "website-js-toolbox";

const { 
    Logger,
    FlashMessages
} = WebsiteJsToolbox;


Logger.info('Hell yes, we are logging an info message!');
FlashMessages.success('This is a success');

Some components like FlashMessages requires the library css to be imported into your stylesheets:

@import '../../node_modules/website-js-toolbox/dist/website-js-toolbox.min.css';

See the application and code located in docs/demo directory to have more information about how to use the components.

Executing the Demo App

This library comes with a full demo of all components.

Install local-web-server if you do not have it yet:

npm install -g local-web-server

Then, the demo can be initialized with:

npm run demo:install
npm run demo:start

The demo should be available at http://127.0.0.1:8000/public/index.html.

Development

Developping tools is pretty straighforward thanks to the demo.

1. Start watchers for the library:

npm run dev

2. Start watchers for the demo:

npm run demo:install

3. Start the demo:

npm run demo:start

Contributing

This project is not open to contributions, but feel free to use it according to the terms of the license.

License

MIT