Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/README: major enhancements explaning several aspects of the package #351

Merged
merged 3 commits into from Mar 8, 2019

Conversation

Projects
None yet
4 participants
@bochaco
Copy link
Member

bochaco commented Mar 6, 2019

No description provided.

@coveralls

This comment has been minimized.

Copy link

coveralls commented Mar 7, 2019

Coverage Status

Coverage increased (+18.8%) to 96.488% when pulling 60e69c1 on bochaco:doc-enhancements into 363c7dd on maidsafe:master.

README.md Outdated
yarn docs
```

The documentation for the API is generated using [jsdoc](https://github.com/jsdoc3/jsdoc). The source code of the `safe_app_ndejs` package has comments embedded which can then be scanned by `jsdoc` script to automatically generate the HTML documentation website/webpages.

This comment has been minimized.

@lionel1704

lionel1704 Mar 8, 2019

Member

Small typo


To run the tests locally, run `yarn test`.

Note: If you are compiling your own [`safe_app`](https://github.com/maidsafe/safe_client_libs/tree/master/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"`.

### Mobile Development
#### Mobile Development

This comment has been minimized.

@lionel1704

lionel1704 Mar 8, 2019

Member

For mobile development we will need the native libraries for android/iOS. I tried setting this flag and it skipped system_uri but it did not download the mobile native libraries.

Even if it did download the native libs, will I be able to use safe-node-app for mobile development? Has anyone tried this before?

This comment has been minimized.

@bochaco

bochaco Mar 8, 2019

Author Member

I don't think anyone has tried this, this was just a suggestion we received some time ago since we knew that systen_uri lib wouldn't be needed for mobile. I guess we need to work on this to make the native libs for mobile to be downloaded automatically. If you copy the native safe_app lib manually you should be able to use safe-app-nodejs for mobile.

@bochaco bochaco merged commit 4848474 into maidsafe:master Mar 8, 2019

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
coverage/coveralls Coverage increased (+18.8%) to 96.488%
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.