Textile binary installation module for Node (npm-go-textile)

Official Textile binary installation module for Node/npm

Join us on our public Slack channel for news, discussions, and status updates.

Background
Usage
Development
Documentation
Maintainer
Contributing
License
About

Background

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.

Usage

This module installs go-textile from npm. It uses @textile/npm-go-textile to download the latest/specified version of go-textile, and is kept in sync with go-textile releases.

For more control over installing go-textile in JS projects, see @textile/go-textile.

Install globally

You can install go-textile globally, which is useful for fetching the latest go-textile installation, running tutorials/workshops, or just generally playing around with Textile from the comfort of tools you already know and use:

npm install -g @textile/go-textile
textile version

Install locally

npm install @textile/go-textile
textile version

Development

Note: The file bin/textile is a placeholder; when downloading stuff, it gets replaced. Do not commit this file, as then you would be commiting a large binary and publishing it to npm!

# Run all the unit tests
npm run test

# Lint everything
# NOTE: Linting uses `prettier` to auto-fix styling issues when possible
npm run lint

You can also compile the Typescript yourself with:

npm run build

If you want to push out a new release, simply 'bump' the npm-go-textile-dep version in package.json and run npm version {path|minor|major} to run the CI-based release process.

Maintainer

Carson Farmer

Contributing

This library is a work in progress. As such, there's a few things you can do right now to help out:

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 on Slack.
Log bugs, file 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 go-textile (which is where the binary is built). 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.
Add tests. There can never be enough tests.
Contribute to the Textile docs with any additions or questions you have about Textile and its various implementations. A good example would be asking, "What is an Textile daemon". If you don't know a term, odds are someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make Textile even better.

Before you get started, be sure to read our contributors guide and our contributor covenant code of conduct.

License

MIT

About

This package was heavily inspired (it started as a direct fork) by the npm-go-ipfs library. Big thanks to all the contributors to that original package! See package.json, LICENSE, and CHANGELOG.md in that project for details and contributions.

textileio/npm-go-textile