mirror of
https://github.com/fluencelabs/fluence-js.git
synced 2024-12-05 02:10:18 +00:00
6436cd5684
* FluenceClient renamed to FluencePeer. * Using Aqua compiler is now the recommended way for all interaction with the network, including services registration and sending requests * Old API (sendParticle etc) has been removed * Opaque seed format replaced with 32 byte ed25519 private key. KeyPair introduced * Documentation update
58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
# Fluence JS SDK
|
|
|
|
[](https://www.npmjs.com/package/@fluencelabs/fluence)
|
|
|
|
Official SDK providing javascript-based implementation of the Fluence Peer.
|
|
|
|
## Getting started
|
|
|
|
To start developing applications with JS SDK refer to the official [gitbook page](https://doc.fluence.dev/docs/js-sdk)
|
|
|
|
## 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](CONTRIBUTING.md).
|
|
|
|
### Setting up dev environment
|
|
|
|
Install node packages
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
docker run --rm -e RUST_LOG="info" -p 1210:1210 -p 4310:4310 fluencelabs/fluence:freeze -t 1210 -w 4310 -k gKdiCSUr1TFGFEgu2t8Ch1XEUsrN5A2UfBLjSZvfci9SPR3NvZpACfcpPGC3eY4zma1pk7UvYv5zb1VjvPHwCjj
|
|
```
|
|
|
|
To run all tests in interactive mode
|
|
|
|
```bash
|
|
npm run test
|
|
```
|
|
|
|
To run only unit tests
|
|
|
|
```bash
|
|
npm run test:unit
|
|
```
|
|
|
|
To run only integration tests
|
|
|
|
```bash
|
|
npm run test:unit
|
|
```
|
|
|
|
To run all tests
|
|
|
|
```bash
|
|
npm run test:all
|
|
```
|
|
|
|
## License
|
|
|
|
[Apache 2.0](LICENSE)
|