weaver-sdk
v26.1.0-rc.1
Published
Weaver SDK for JavaScript
Keywords
Readme
Weaver SDK for JavaScript
A library that gives you access to the Weaver platform from your JavaScript app.
This readme covers development documentation, for usage documentation, see: weaver-docs
Docker composition
To get a weaver installation up and running, use the following command:
./start-backend.shThis pulls the weavebase-api repo, builds the api from there, and runs tests on the docker compose stack in that repository.
Integration test suite on CI
In the .gitlab-ci.yml file the branch of the weavebase-api for the continuous
integration tests is set. In order to run a full test on an updated version of
the weavebase-api, or use updated images, update the mentioned branch to the
feature version that needs testing.
Install dependencies
$ yarnRun tests
Please note that these require a running weaver installation (such as provided by the docker composition), and the contents of that installation will be wiped as part of the test run.
$ yarn testBy default most output is suppressed. In order to enable console.logs for
local testing, comment out the following line in test/globalize.coffee:
# Suppress log output
require('mocha-suppress-logs')()Coding style
Follow the sysunite coffeescript style guide
CI Notes for this repo
SAST has been configured and runs on a MR, the output report is on JSON format. In order to view the report on a more human way:
- download the json report from MR's Overview page; artifacts called
semgrep-stast:sast - copy the content
- paste the content on https://sast-report-explorer.vercel.app/
