Skip to content

Lenra's app lib for JavaScript and TypeScript apps

License

Notifications You must be signed in to change notification settings

lenra-io/app-lib-js

Repository files navigation

Contributors Forks Stargazers Issues MIT License


App Lib for javaScript based projects

This lib integrates Express server and all the elements the app needs in order to only keep the views, listeners and resources in the app project.

Report Bug · Request Feature

Usage

To incorporate it into your Lenra app project, simply run the following command:

npm i @lenra/app-server

Lenra API calls

To call a Lenra API from a listener, utilize the Api instance provided as the third parameter in your listener function.

You can then create a document using the data API with the following code:

class CustomType extends Data {
    /**
     * @param {string} value
     */
  constructor(value) {
    this.value = value;
  }
}

const myDoc = await api.data.coll(CustomType).createDoc(new CustomType("Hello world"));

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please open an issue with the tag "enhancement". Don't forget to give the project a star if you liked it! Thanks again!generate

Generate classes

A part of this lib is generated from the Lenra API. To generate the classes, run the following commands:

# Load API
## With wget
wget https://github.com/lenra-io/api/releases/latest/download/load-api.sh -O - -q | bash
## With curl
curl -fsSL https://github.com/lenra-io/api/releases/latest/download/load-api.sh | bash
# generate
npm run generate

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Lenra - @lenra_dev - contact@lenra.io

Project Link: https://github.com/lenra-io/app-lib-js

(back to top)