Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/textileio/go-textile
[DEPRECATED] Textile is a set of tools and infrastructure for building composable apps and services on the IPFS network
https://github.com/textileio/go-textile
android decentralized encrypted golang ios ipfs libp2p linux macos windows
Last synced: 3 months ago
JSON representation
[DEPRECATED] Textile is a set of tools and infrastructure for building composable apps and services on the IPFS network
- Host: GitHub
- URL: https://github.com/textileio/go-textile
- Owner: textileio
- License: mit
- Archived: true
- Created: 2018-03-07T17:19:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-03-04T03:13:16.000Z (almost 5 years ago)
- Last Synced: 2024-09-05T01:33:16.038Z (3 months ago)
- Topics: android, decentralized, encrypted, golang, ios, ipfs, libp2p, linux, macos, windows
- Language: Go
- Homepage: https://textile.io
- Size: 84.4 MB
- Stars: 357
- Watchers: 30
- Forks: 43
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-starred - textileio/go-textile - [DEPRECATED] Textile is a set of tools and infrastructure for building composable apps and services on the IPFS network (windows)
README
### ** WARNING **: **[go-textile](https://github.com/textileio/go-textile) has been replaced by [go-threads](https://github.com/textileio/go-threads) and [textile](https://github.com/textileio/textile).**
---
# go-textile
[](https://textile.io)
[](https://slack.textile.io)
[](./LICENSE)
[](https://goreportcard.com/report/github.com/textileio/go-textile?style=flat-square)
[](https://circleci.com/gh/textileio/go-textile)
[](https://github.com/RichardLitt/standard-readme)
> Textile implementation in Go
This repository contains the core API, daemon, and command-line client, as well as bindings for mobile (iOS/Android) applications.
[Textile](https://www.textile.io) provides encrypted, recoverable, schema-based, and cross-application data storage built on [IPFS](https://github.com/ipfs) and [libp2p](https://github.com/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**.
**Please see [Textile Docs](https://docs.textile.io/) for more**.
Join us on our [public Slack channel](https://slack.textile.io/) for news, discussions, and status updates. [Check out our blog](https://medium.com/textileio) for the latest posts and announcements.
## Table of Contents
- [Security](#security)
- [Background](#background)
- [Install](#install)
- [Usage](#usage)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
## Security
Textile is still under heavy development and no part of it should be used before a thorough review of the underlying code and an understanding that APIs and protocols may change rapidly. There may be coding mistakes and the underlying protocols may contain design flaws. Please [let us know](mailto:[email protected]) immediately if you have discovered a security vulnerability.
Please also read the [security note](https://github.com/ipfs/go-ipfs#security-issues) for [go-ipfs](https://github.com/ipfs/go-ipfs).
## Background
Textile is a set of tools and trust-less infrastructure for building _censorship resistant_ and _privacy preserving_ applications.
While interoperable with the whole [IPFS](https://ipfs.io/) peer-to-peer network, Textile-flavored peers represent an additional layer or sub-network of **users, applications, and services**.
With good encryption defaults and anonymous, disposable application services like [cafes](https://docs.textile.io/concepts/cafes/), Textile aims to bring the decentralized internet to real products that people love.
[Continue reading](https://docs.textile.io/concepts/) about Textile...
## Install
env GO111MODULE=on go get github.com/textileio/go-textile
env GO111MODULE=on go install github.com/textileio/go-textile/cmd/textile
[Installation instructions](https://docs.textile.io/install/the-daemon/) for pre-built binaries are in [the docs](https://docs.textile.io).
## Usage
Go to https://godoc.org/github.com/textileio/go-textile.
The [Tour of Textile](https://docs.textile.io/a-tour-of-textile/) goes through many examples and use cases. `textile --help` provides a quick look at the available APIs. For a full overview of every CLI command available, refer to our [Command Line Documentation](https://docs.textile.io/develop/clients/command-line/).
### Requirements
- go >= 1.12
Extra setup steps are needed to build the bindings for iOS or Android, as `gomobile` does not yet support [go modules](https://github.com/golang/go/wiki/Modules). You'll need to **move the go-textile source** into your `GOPATH` (like pre-go1.11 development), before installing and initializing the `gomobile` tools:
go get golang.org/x/mobile/cmd/gomobile
gomobile init
Now you can execute the iOS and Android build tasks below. For the other build tasks, the source must _not_ be under `GOPATH`. Go 1.13 is supposed to bring module support to `gomobile`, at which point we can remove this madness!
### Install dependencies:
make setup
### Build `textile`:
make textile
### Run unit tests:
make test
### Build the iOS framework:
make ios
### Build the Android Archive Library (aar):
make android
### Build the swagger docs:
make docs
## Contributing
This project 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](https://slack.textile.io) on Slack.
- **Open issues**, [file issues](https://github.com/textileio/go-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.
Before you get started, be sure to read our [contributors guide](./CONTRIBUTING.md) and our [contributor covenant code of conduct](./CODE_OF_CONDUCT.md).
## Changelog
[Changelog is published to Releases.](https://github.com/textileio/go-textile/releases)
## License
[MIT](LICENSE)