SolidLabLib.js

A library of helper functions for developing Solid apps in TypeScript/JavaScript.

The easiest way to make use of this library is via the @solidlab/lib package, which is a bundle of all helper functions defined in SolidLabLib. Alternatively, these helper functions can also be installed separately.

Development Setup

(JSDoc: https://SolidLabResearch.github.io/SolidLabLib.js/)

This repository should be used by SolidLabLib module developers as it contains multiple SolidLabLib modules that can be composed. This repository is managed as a monorepo using Lerna.

If you want to develop new features or use the (potentially unstable) in-development version, you can set up a development environment.

SolidLabLib requires Node.JS 14.0 or higher and the Yarn package manager. SolidLabLib is tested on OSX, Linux and Windows, both in Node.js and in browsers (Chrome and Firefox).

This project can be setup by cloning and installing it as follows:

$ git clone https://github.com/SolidLabResearch/SolidLabLib.js.git
$ cd SolidLabLib.js
$ yarn install

Note: npm install is not supported at the moment, as this project makes use of Yarn's workspaces functionality

This will install the dependencies of all modules, and bootstrap the Lerna monorepo. After that, all SolidLabLib packages are available in the packages/ folder and can be used in a development environment, such as the lib package tool.

Furthermore, this will add pre-commit hooks to build, lint and test. These hooks can temporarily be disabled at your own risk by adding the -n flag to the commit command.

License

This code is copyrighted by Ghent University – imec and released under the MIT license.