storj/README.md

87 lines
2.7 KiB
Markdown
Raw Normal View History

2018-04-06 17:38:32 +01:00
# Storj
2018-04-06 17:32:34 +01:00
[![Go Report Card](https://goreportcard.com/badge/github.com/golang-standards/project-layout?style=flat-square)](https://goreportcard.com/report/github.com/storj/storj)
[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/storj/storj)
[![Release](https://img.shields.io/github/release/golang-standards/project-layout.svg?style=flat-square)](https://github.com/storj/storj/releases/latest)
2018-04-06 17:39:49 +01:00
<img src="https://github.com/Storj/storj/blob/wip/logo/logo.png" width="100">
2018-04-06 17:32:34 +01:00
----
Storj is a platform, token, and suite of decentralized applications that allows you to store data in a secure and decentralized manner. Your files are encrypted, shredded into little pieces called 'shards' and stored in a global decentralized network of computers. Only you have access and the ability to retrieve all shards from the network, decrypt them, and finally re-combine all file pieces into your original file.
2018-04-06 17:32:34 +01:00
----
## To start using Storj
See our documentation at [Storj docs](https://docs.storj.io/docs).
2018-04-06 17:32:34 +01:00
## To start developing Storj
2018-04-06 17:32:34 +01:00
The [community site](https://storj.io/community.html) hosts all information about building storj from source, how to contribute code
2018-04-06 17:32:34 +01:00
and documentation, who to contact about what, etc.
2018-04-17 14:38:31 +01:00
### Install VGO
```Go
go get -u golang.org/x/vgo
```
### Install non-go development dependencies
In order to develop on Storj, you will need to have the `protobuf` compiler installed on your system.
1. Grab the latest release for your system from [here](https://github.com/google/protobuf/releases).
2018-04-17 14:38:31 +01:00
1. place the `protoc` binary in your path. i.e.
```bash
mv $HOME/Downloads/protoc-<version>-<arch>/bin/protoc /usr/local/bin
2018-04-17 14:38:31 +01:00
```
### Install go dependencies
Use vgo to install both dev and non-dev dependencies.
1. Install development dependencies
2018-04-17 18:29:15 +01:00
```
make build-dev-deps
```
1. Install project dependencies
```bash
# in project root
vgo install
```
If you want to build Storj right away there are two options:
2018-04-06 17:32:34 +01:00
##### You have a working [Go environment](https://golang.org/doc/install).
```
$ go get -d storj.io/storj
$ cd $GOPATH/src/storj.io/storj
$ make
```
##### You have a working [Docker environment](https://docs.docker.com/engine).
```
$ git clone https://github.com/storj/storj
$ cd storj
$ make docker
```
For the full story, head over to the [developer's documentation].
## Support
If you need support, start with the [troubleshooting guide], and work your way through the process that we've outlined.
2018-04-06 17:32:34 +01:00
That said, if you have any questions or suggestions please reach out to us on [rocketchat](https://storj.io/community.html) or [twitter](https://twitter.com/storjproject).