storj/README.md
2018-04-17 13:29:15 -04:00

2.5 KiB

Storj

Go Report Card Go Doc Release


Storj is a platform, cryptocurrency, 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 decentralized network of computers around the globe. No one but you has a complete copy of your file, not even in an ecrypted form.


To start using Storj

See our documentation at storj docs.

To start developing storj

The community site hosts all information about building storj from source, how to contribute code and documentation, who to contact about what, etc.

Install VGO

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

  2. place the protoc binary in your path. i.e

    mv $HOME/Downloads/protoc-<version>-<arch>/bin/protoc /usr/local/bin
    

Install go dependencies

Use vgo to install both dev and non-dev dependencies

  1. Install development dependencies

    make build-dev-deps
    
  2. Install project dependencies

    # in project root
    vgo install
    

If you want to build storj right away there are two options:

You have a working Go environment.
$ go get -d storj.io/storj
$ cd $GOPATH/src/storj.io/storj
$ make
You have a working Docker environment.
$ 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.

That said, if you have questions, reach out to us twitter.