.github/workflows | ||
aqua | ||
docs | ||
src | ||
.editorconfig | ||
.eslintrc.js | ||
.gitignore | ||
.npmignore | ||
.prettierrc.js | ||
CONTRIBUTING.md | ||
jest.config.js | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json | ||
typedoc.json | ||
typedoc.md |
Fluence JS
Official TypeScript implementation of the Fluence Peer.
Getting started
To start developing applications with Fluence JS refer to the official documentation
Contributing
While the project is still in the early stages of development, you are welcome to track progress and contribute. As the project is undergoing rapid changes, interested contributors should contact the team before embarking on larger pieces of work. All contributors should consult with and agree to our basic contributing rules.
Setting up dev environment
Install node packages
npm install
Running tests
Tests are split into unit and integration categories. By default integration tests require a locally running Fluence node with 4310 port open for ws connections. The dependency can be started with docker
docker run --rm -e RUST_LOG="info" -p 1210:1210 -p 4310:4310 fluencelabs/fluence -t 1210 -w 4310 -k gKdiCSUr1TFGFEgu2t8Ch1XEUsrN5A2UfBLjSZvfci9SPR3NvZpACfcpPGC3eY4zma1pk7UvYv5zb1VjvPHwCjj
To run all tests in interactive mode
npm run test
To run only unit tests
npm run test:unit
To run only integration tests
npm run test:unit
To run all tests
npm run test:all