[DEPRECATED] Official Textile JS HTTP Wrapper Client
Official Textile JS HTTP Wrapper Client
Join us on our public Slack channel for news, discussions, and status updates. For current status, and where you can help, please see issue #1.
Important: With the move to Typescript and our 0.2.x release, js-http-client
is now
published under the @textile
namespace, rather than @textileio
. Previous
releases will remain available under @textileio
, however, all
code should be updated to reflect this change.
Textile provides encrypted, recoverable, schema-based, and cross-application data storage built on IPFS and libp2p. We like to think of it as a decentralized data wallet with built-in protocols for sharing and recovery, or more simply, an open and programmable iCloud.
The reference implementation of Textile is written in Go, and can be compiled to various platforms, including mobile (Android/iOS) and desktop/server (OSX, Windows, Linux, etc). The library in this repo is designed to help support things like browser-based Textile apps, Node.js apps, and other use-cases.
This library provides access to an underlying go-textile
node's REST API, adding various simplified APIs to support in-browser and programmatic desktop access. For the most part, the API would mimic the command-line and/or mobile APIs of go-textile
, with some browser-specific enhancements.
# Run all the unit tests
yarn test
# Lint everything
# NOTE: Linting uses `prettier` to auto-fix styling issues when possible
yarn lint
You can also compile the Typescript yourself with:
yarn build
And even build a nice browser-compatible bundle with:
yarn browser
These will both build and add the exported Javascript files to dist
, ready to be used in your next NodeJS, browser, React, Vue, or whatever app!
We also provide scripts to run a light-weight webpack-dev-server
to test out the browser builds. Try something like yarn serve
, and then browse to http://127.0.0.1:8080/examples/browser
in your favorite browser for a simple example.
The auto-generated documentation can be found at https://textileio.github.io/js-http-client/.
# Re-build the documentation
yarn docs
Textile's JS HTTP Client is a work in progress. As such, there's a few things you can do right now to help out:
textile-mobile
and the Textile react-native-sdk
. Contributions here that would be most helpful are top-level comments about how it should look based on our understanding. Again, the more eyes the better.Before you get started, be sure to read our contributors guide and our contributor covenant code of conduct.
Commits | Contributor |
---|---|
116 | carsonfarmer |
26 | andrewxhill |
3 | flyskywhy |
3 | dependabot[bot] |
2 | robbynshaw |
1 | asutula |
1 | balupton |
1 | connectdotz |