safe_app_nodejs

A safe_app library for Node.js.

Maintainer: Gabriel Viganotti ([email protected])

Linux/OS X	Windows	Coverage Status

API Documentation

The documentation for the safe_app Node.js API is available at http://docs.maidsafe.net/safe_app_nodejs/.

Development

1. Prerequisites

   • Node.js ^8.0.0 (we recommend installing it via nvm)
   • Git
   • Yarn (as a replacement for npm).

2. Clone this GitHub repository:

   git clone https://github.com/maidsafe/safe_app_nodejs.git

3. Install the dependencies:

   cd safe_app_nodejs
   yarn

   If you are working on a development environment, you can run NODE_ENV=dev yarn instead in order to get the safe_app library which uses the MockVault file rather than connecting to the actual SAFE Network.

Testing

To run the tests locally, make sure you installed the safe_app library with NODE_ENV=dev yarn, then you can run them by executing yarn test.

Note: If you are compiling your own safe_app library for testing purposes, and if you want to be able to run the tests, make sure to include testing in your build features when compiling safe_app in safe_client_libs, i.e. cargo build --release --features "use-mock-routing testing".

Further Help

You can discuss development-related questions on the SAFE Dev Forum. Here's a good post to get started: How to develop for the SAFE Network.

License

This SAFE Network library is dual-licensed under

• the Modified BSD (LICENSE-BSD) or
• the MIT license (LICENSE-MIT)

at your option.

Contribution

Copyrights in the SAFE Network are retained by their contributors. No copyright assignment is required to contribute to this project.