fluencelabs/fluence-js
1
0
Fork 0
mirror of https://github.com/fluencelabs/fluence-js.git synced 2024-12-05 02:10:18 +00:00
Code Issues Projects Releases Wiki Activity
JS/TS Peer for the Fluence p2p network
181 Commits 32 Branches 260 Tags 71 MiB
TypeScript 92.9%
JavaScript 6.5%
HTML 0.4%
CSS 0.2%
b68d61068a
Go to file
Anatoly Laskaris b68d61068a
Use workflow_call to run tests/publish build snapshot and add E2E (#175) 
* Add workflow_call

* Add missing import secrest

* Run e2e with aqua-playground (#179)

* Try to run e2e with aqua-playground

* Use workflow_call to run local tests and publish snapshot

* Run e2e and tests in parallel

* Colors!

* Always add comment

* Use master branch of aqua-playground

* Remove invalid `cache` key

* Update .github/workflows/run-tests.yml

* Fix branch name in version
2022-09-06 17:51:43 +03:00
.github Use workflow_call to run tests/publish build snapshot and add E2E (#175) 2022-09-06 17:51:43 +03:00
docs Ephemeral networks core implementation (#160) 2022-08-05 16:43:19 +03:00
packages Update @fluencelabs/avm to v0.27.8 and @fluencelabs/marine-js to v0.3.10 (#180) 2022-09-06 13:33:17 +03:00
.editorconfig Turn on noImplicitAny and strictNullChecks (#153) 2022-05-12 17:14:16 +03:00
.gitignore Migrate to monorepo and pnpm (#163) 2022-08-24 18:03:06 +03:00
.npmrc Migrate to monorepo and pnpm (#163) 2022-08-24 18:03:06 +03:00
ci.js Fix issue when FluenceJS was not working in webpack-based web projects (#176) 2022-09-05 18:24:19 +03:00
CONTRIBUTING.md Returned built-in Aquamarine calls, updated docs (#11) 2021-01-29 16:48:27 +03:00
LICENSE Returned built-in Aquamarine calls, updated docs (#11) 2021-01-29 16:48:27 +03:00
pnpm-lock.yaml Update @fluencelabs/avm to v0.27.8 and @fluencelabs/marine-js to v0.3.10 (#180) 2022-09-06 13:33:17 +03:00
pnpm-workspace.yaml Fix issue when FluenceJS was not working in webpack-based web projects (#176) 2022-09-05 18:24:19 +03:00
README.md Migrate to monorepo and pnpm (#163) 2022-08-24 18:03:06 +03:00
typedoc.json Migrate to monorepo and pnpm (#163) 2022-08-24 18:03:06 +03:00
typedoc.md Documentation update (#83) 2021-09-27 22:11:35 +03:00

README.md

Fluence JS

npm

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

Fluence JS uses pnpm to manage monorepo packages. See pnpm.io for installation instructions.

Install dependencies

pnpm install

Build all packages

pnpm -r build

Repository structure

Folder Package Description
packages/fluence-js @fluencelabs/fluence-js TypeScript implementation of the Fluence Peer
packages/fluence-interfaces @fluencelabs/interfaces Common interfaces used in Fluence Peer
packages/fluence-connection @fluencelabs/connection Connectivity layer used in Fluence Peer
packages/fluence-keypair @fluencelabs/keypair Key Pair implementation

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

pnpm -r test

To run only unit tests

pnpm -r test:unit

To run only integration tests

pnpm -r test:integration

License

Apache 2.0