Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.2 KB

README.md

File metadata and controls

63 lines (39 loc) · 2.2 KB
Raw

LaxarJS Build Status

Middleware for your web client: Create maintainable applications from small, isolated parts.

Why LaxarJS?

Find out why you would use LaxarJS and if it's the right tool for you. Then, explore the core concepts and browse the manuals in the documentation. Also, there is a glossary where you can lookup individual concepts, and a troubleshooting guide there for you if you need it.

Have a look at the LaxarJS website for demos and more information. Take a look at the documentation site to browse documentation for all releases of this artifact.

Getting Started

Here are the basic instructions to get started:

Requirements

LaxarJS v2 can be loaded without installing additional dependencies:

The release bundle dist/laxar.with-deps.js contains LaxarJS itself as well as its only dependency, the Navigo micro-library for routing.

However, the following browser capabilities are required:

  • native ES5 support (MSIE < 9 is not supported)
  • Support for the following ES6 features (native or poly-filled):
    • Promise
    • Fetch
    • Array.from

Polyfills for these features can be obtained by simply loading dist/polyfills.js through a script tag.

Hacking LaxarJS itself

Instead of using the compiled library within a project, you can also clone this repository:

git clone https://github.com/LaxarJS/laxar.git
cd laxar
npm install

To see changes in your application, either configure your project to work with the sources (e.g. by using Webpack), or rebuild the Webpack bundles by running npm run dist.

To run the automated karma tests:

npm test

To generate HTML spec runners for opening in your web browser, so that you can e.g. use the browser's developer tools:

npm run browser-spec

Now you can select a spec-runner by browsing to http://localhost:8081/spec-output/.