Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/textileio/js-textile
Textile's JavaScript Libs. Home of ThreadDB, Buckets, and more. Available on npm as `@textile/hub`.
https://github.com/textileio/js-textile
apis buckets client ipfs javascript threads typescript
Last synced: about 1 month ago
JSON representation
Textile's JavaScript Libs. Home of ThreadDB, Buckets, and more. Available on npm as `@textile/hub`.
- Host: GitHub
- URL: https://github.com/textileio/js-textile
- Owner: textileio
- License: mit
- Created: 2019-02-22T19:10:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T13:58:15.000Z (over 1 year ago)
- Last Synced: 2024-05-29T11:03:39.700Z (6 months ago)
- Topics: apis, buckets, client, ipfs, javascript, threads, typescript
- Language: TypeScript
- Homepage: https://textileio.github.io/js-textile/docs
- Size: 15 MB
- Stars: 84
- Watchers: 6
- Forks: 19
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## DEPRECATION NOTICE: Textile's _hosted_ Hub infrastructure will be taken off-line on January 9th, 2023. At this time, all ThreadDB and Bucket data will no longer be available, and will subsequently be removed. See https://github.com/textileio/textile/issues/578 for further details.
# JS-Textile
[](https://textile.io)
[](https://slack.textile.io)
[](./LICENSE)
> Typescript/Javascript libs for interacting with Textile APIs.
Go to [the docs](https://docs.textile.io/) for more about Textile.
Join us on our [public Discord server](https://discord.com/invite/dc8EBEhGbg) for news, discussions, and status updates.
## Table of Contents
- [js-textile](#js-textile)
- [Install](#install)
- [Usage](#usage)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
## Install
`npm install @textile/hub`
## Usage
> We are shutting down our hosted Hub infrastructure. Please see this [deprecation notice](https://github.com/textileio/textile/issues/578) for details.
`@textile/hub` provides access to Textile APIs in apps based on API Keys. For details on getting keys, see [textileio/textile](https://docs.textile.io/hub/) or join our [Discord](https://discord.com/invite/dc8EBEhGbg).
## Contributing
This project is no longer under active development. If you'd like to get something change/fixed/updated, here are some ways to make that happen:
- **Ask questions**! We'll try to help. Be sure to drop a note (on the above issue) if there is anything you'd like to work on and we'll update the issue to let others know. Also [get in touch](https://discord.com/invite/dc8EBEhGbg) on Slack.
- **Open issues**, [file issues](https://github.com/textileio/js-textile/issues), submit pull requests!
- **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
- **Take a look at the code**. Contributions here that would be most helpful are **top-level comments** about how it should look based on your understanding. Again, the more eyes the better.
- **Add tests**. There can never be enough tests.
### Building docs
On mac, docs require gnu-sed.
```
brew install gnu-sed
```
Follow `brew info gnu-sed` instructions to make it default sed.
Install Docusaurus
```
cd website
npm install
cd ..
```
Update markdown
```
npm run docs
```
Run docs server
```
npm run serve:docs
```
## Changelog
[Changelog is published to Releases.](https://github.com/textileio/js-textile/releases)
## License
[MIT](LICENSE)