README

• liqueur-js
  • Installation
    • Composer
    • Laravel
  • Quick start
  • Documentation
  • Examples
  • Demo applications
    • Contributing
  • License

Installation

Composer

Use composer to install the library

composer require eto-pesets/liqueur-js

Laravel

To use with Laravel you should publish library files to assets. For example: (change paths to fit your project's structure)

1. Add this code to AppServiceProvider::boot()

$this->publishes([
    // modules
    __DIR__.'/../../vendor/eto-pesets/liqueur-js/src' => public_path('assets/js/liqueur-js/src'),
    // browser bundle
    __DIR__.'/../../vendor/eto-pesets/liqueur-js/dist' => public_path('assets/js/liqueur-js/dist'),
], 'liqueur-js');

1. Publish the files

php artisan vendor:publish --tag=liqueur-js

Or add this script to composer.json so it will run automatically after composer update

"post-update-cmd": [
    ...,
    "@php artisan vendor:publish --tag=liqueur-js"
],
            

Quick start

Import the main file:

Module:

import { Liqueur, Syrup, Alcohol /*, ... */ } from '/path/to/src/index.js';

Browser bundle:

<script src="/path/to/dist/bundle.js"></script>
<script>
	const { Liqueur, Syrup, Alcohol /*, ... */ } = LiqueurJS;
</script>

Documentation

Conceptual and technical documentation is available in the following sections:

• API
  • API overview
  • local or hosted JSDoc reference
• Model description
  • Physical model

Examples

See Examples

Demo applications

See Composition demo, Conversion demo and Liqueur calculator

Contributing

Contributions are welcome.

If you would like to help improve the project, the most valuable contributions at the moment are:

• Language files (i18n/{code}.js)
  Expanding and improving translations.

• Documentation improvements (*.md, JSDoc)
  Enhancements to Markdown documentation and JSDoc reference:

  • clarifications
  • examples
  • corrections
  • structural improvements

License

Apache-2.0