mirror of
https://github.com/fluencelabs/fluence-js.git
synced 2025-03-15 07:20:49 +00:00
9667c4fec6
- Move marine-related part into FJS repo (fixes DXJ-184) - Move towards component-oriented architecture (fixes DXJ-183) - Different JS Client distros for node.js and web (fixes DXJ-185) - Update libp2p to 0.42.2 (fixes DXJ-26) - Add JS Client API (fixes DXJ-196, fixes DXJ-177, fixes DXJ-60) - Add Smoke test for JS Client web (fixes DXJ-253) --------- Co-authored-by: Anatoly Laskaris <github_me@nahsi.dev>
60 lines
1.5 KiB
Markdown
60 lines
1.5 KiB
Markdown
# Fluence JS
|
|
|
|
[](https://www.npmjs.com/package/@fluencelabs/fluence)
|
|
|
|
Official TypeScript implementation of the Fluence Peer.
|
|
|
|
## Getting started
|
|
|
|
To start developing applications with Fluence JS refer to the official [documentation](https://fluence.dev/docs/build/fluence-js/)
|
|
|
|
## 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
|
|
|
|
Fluence JS uses pnpm to manage monorepo packages. See [pnpm.io](https://pnpm.io/installation) for installation instructions.
|
|
|
|
Install dependencies
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
Build all packages
|
|
|
|
```
|
|
pnpm -r build
|
|
```
|
|
|
|
### 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 -t 1210 -w 4310 -k gKdiCSUr1TFGFEgu2t8Ch1XEUsrN5A2UfBLjSZvfci9SPR3NvZpACfcpPGC3eY4zma1pk7UvYv5zb1VjvPHwCjj
|
|
```
|
|
|
|
To run all tests
|
|
|
|
```bash
|
|
pnpm -r test
|
|
```
|
|
|
|
To run only unit tests
|
|
|
|
```bash
|
|
pnpm -r test:unit
|
|
```
|
|
|
|
To run only integration tests
|
|
|
|
```bash
|
|
pnpm -r test:integration
|
|
```
|
|
|
|
## License
|
|
|
|
[Apache 2.0](LICENSE)
|