-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #21 from Bit-Nation/develop
update master with latest development
- Loading branch information
Showing
8 changed files
with
257 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,63 @@ | ||
# Panthalassa | ||
> Bitnation's backend - contains the mesh and some utils | ||
# panthalassa | ||
|
||
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) | ||
[![Build Status](https://semaphoreci.com/api/v1/florianlenz/panthalassa/branches/develop/badge.svg)](https://semaphoreci.com/florianlenz/panthalassa) (Develop) | ||
[![Build Status](https://semaphoreci.com/api/v1/florianlenz/panthalassa/branches/master/badge.svg)](https://semaphoreci.com/florianlenz/panthalassa) (Master) | ||
|
||
> Backend for Pangea | ||
## Development | ||
TODO: Fill out this long description. | ||
|
||
1. Clone the project into `$GOPATH/src/github.com/Bit-Nation/panthalassa` | ||
2. Run `make` to see all available commands | ||
## Table of Contents | ||
|
||
### Install | ||
1. Run `make deps` to get the needed dependencies | ||
2. Run `make install` to install the gx dependencies | ||
3. Run `make deps_hack` to rewrite the import paths | ||
- [Security](#security) | ||
- [Background](#background) | ||
- [Install](#install) | ||
- [Usage](#usage) | ||
- [API](#api) | ||
- [Maintainers](#maintainers) | ||
- [Contribute](#contribute) | ||
- [License](#license) | ||
|
||
### Build for ios | ||
- Follow the install section first | ||
- Run `make ios` to build for ios | ||
## Security | ||
If you find a bug / vulnerability please DO NOT open an issue. Write to `[email protected]` PLEASE use [this](security-bitnation.co.key.pub) PGP key to encrypt your report / email. | ||
|
||
### Build for android | ||
- Follow the install section first | ||
- Run `make android` to build for android | ||
## Background | ||
[Pangea](https://github.com/Bit-Nation/BITNATION-Pangea-mobile) is the mobile interface to our blockchain jurisdiction. While smart contract's are "onchain" (on a blockchain like Ethereum) communication happens offchain. | ||
Since current chat systems like WhatsApp and Telegram are hevaly centralized, we are using a p2p system to send messages between peers so that bitnaiton doesn't become a central point of failure. | ||
We are using [libp2p](https://github.com/libp2p) for the p2p network, which is a great project. | ||
|
||
## Install | ||
|
||
First clone the project. You can run the commands from the `Usage` section. | ||
|
||
## Usage | ||
We are using GX as the dependency manager since libp2p (and almost all go projects from [Protocol Labs](https://protocol.ai/)) use it as the dependecny manager. | ||
However, you don't need to pay attention to it, since you just have to use the make file. The following commands are available: | ||
- `make list` (or just `make`) will list all commands from the Makefile. | ||
- `make deps` will fetch tools that you need in order to work with the project. | ||
- `make install` will install all dependencies needed in order to work with the project. | ||
- `make deps_hack` will "hack" your dependencies. GX rewrites your import paths `github.com/libp2p/go-libp2p` e.g. becomes `gx/ipfs/QmNh1kGFFdsPu79KNSaL4NUKUPb4Eiz4KHdMtFY6664RDp/go-libp2p`. You need this in order to work with the package versions specified in the package.json. | ||
- `make deps_hack_revert` will undo `make deps_hack`. We never want to commit the GX import paths. | ||
- `make deps_mobile` will install some tools needed to build panthalassa for mobile. You need to run this before you can build for ios and android. | ||
- `make ios` will build panthalassa for ios and place it in the `build` folder. | ||
- `make android` will build panthalassa for android and place it in the build folder. | ||
- `make test` will format the code and run all tests. | ||
- `make test_coverage` will test the code and open the coverage report. | ||
|
||
## API | ||
> TODO - add link to godoc.org | ||
## Maintainers | ||
|
||
[@florianlenz](https://github.com/florianlenz) | ||
|
||
## Contribute | ||
|
||
Pull requests are accepted. | ||
|
||
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specifications. | ||
|
||
## License | ||
|
||
MIT © 2018 [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
-----BEGIN PGP PUBLIC KEY BLOCK----- | ||
|
||
mQINBFoxGfcBEADCq6ZyJYeFftMKbx6zqL4hXXLg9dvM94Sryc29Vd2eoOXoiINU | ||
RtftPKQZ4uMufyrPHO0RUbgW4R6ZFu2eQgxlguTUyfIzWmGwrBJcrxpjSGG8Oqla | ||
JVHIvHY3JB6Tb0houAu/+hIXDOs+TBH+roNY6M3wfxHCQmuAi2pNkoEemmFcpcJ+ | ||
sNCSqjzg35TcDn78uHYVjB1ettrtnRs9i9ctViWvxsQe32ovG00Kef91RaPX1aFQ | ||
G1AO8snsouRv50SURvdTACjAarTCsMl72NewV0XA9GDlD2MXwWcH7xTex5Gd1W8d | ||
XxF0fGpSoFv2Ld9za2BkVIGMpkDzSHOt8AZQe6GbQwcV/n/XYjpfHsZQZvwfOjhm | ||
Wz1xH2JdCEgjWSSz+lN8t/j3oBGWtQ1vQO0rjcgoZzaWGAHGw8EqcrmEI7i0Jz4z | ||
dRz9PtiETVgRFU8IHGvFJvRv1FwyTsowq1IviEqssJ8BmxSB8MHhLlOOJUcVk8QS | ||
7RA4Wnb3dyUJT1SR3kpTefz8Oqcm/0qH7f20v9DyTUg7MqCgQsFlYChOEF9P34Or | ||
edB22XTpyDR4uiQHPl0a3HGEbx2r8cFNM9S1DUz59RZK+vJLuUAedmXuFU+jJEAn | ||
aM2r0QqvNmgO4byeyIvAa4k7vlqCFU0dGqICQEntAkCgf6Cb+p9xmNviAQARAQAB | ||
tCpCaXRuYXRpb24gU2VjdXJpdHkgPHNlY3VyaXR5QGJpdG5hdGlvbi5jbz6JAk4E | ||
EwEIADgWIQRg7QSs58Z4lXG2Uku47mIRAXJz6gUCWjEZ9wIbAwULCQgHAgYVCAkK | ||
CwIEFgIDAQIeAQIXgAAKCRC47mIRAXJz6je8D/9Sd14hmGreUghR3FBPA9HIRlJj | ||
Dtpbn1xuJZVBfmQlFL63HvyiM7HRfSAlW3PEmFXcaTYTuo4o9oXBT1KU7FAG4toS | ||
acc/UvKHMp8PkoK5y2DmlgfXOIyk18GFFbOCBhGzOMvyXH0mPBVfvuGlwQ9ZYt6R | ||
NxUzXscNsaN+HWCFO8aVr11oDzLyNtLHoLimOij0qEqsHlQKX8mC0F/9TQgj2+df | ||
EpbQjgIQuXBxsq+kRiOS+SDA9AN0f3Qz64yAaLS1JecUb1YFCg/XDSBqvH3NW5Df | ||
uwXnPMqoVEIf6SsAIwTvcwGw+8G4E3nuGlzWxMYB46nCmouXdAtaAqk3xkoOSJtJ | ||
AjCVYa8DBebDX1De6auapHFgXXyHZ++PGFGtIaWlj+tsLwCCbFr/WtNA0yqWgo1y | ||
S5NBVcjB87PghPk4uu5QZ9avw+rHYwZqyvnCea97EEZTXAZWRvx8tDeYWKJ/IzAy | ||
+9qZshxCAOnkw9fb+TjS0GlNUemcf4bUionLZ8r7ZmkzHhlqGXvgunAEDOrPTs7B | ||
O4sPKOYopwQ5Fu8ijYnpRfnSna/NzhpY/be5vMWRAg4xfJs9DKIoFrcgBRPDEC0i | ||
GIE449u5myB5e2cwEfH4Aw84rlKcT6NobBJ40esXvbblMSgTTMIX5hlbSGuH4aGg | ||
NO8FuuxTRlptldHlZ7kCDQRaMRn3ARAAlSjyxU/cX+LbCMIBigf8GOcplSDhBp7v | ||
wLLZITdPX2wdYwPQlZ7UJZoUEf2/Z59RITrN+SGmRioLftUop3r382XEfnFVtGtm | ||
KsIaNjinl46IafOz0Mg4TO37XO/CvzDXgKvbiA3qzYNRjvMRNcEizuhpGT/Y/lf7 | ||
4N4DfSomPw2YmJL1oxgjj4vRnjjwgJTfEbHYMpJTZfyci2SMds6OsqujywJtaVtf | ||
YRec23Rta4DhlKXPQ0O/PCTTGViIsQRUZ1gbvU9LSfOAqFb/XzB0ABRK5B8AIXO8 | ||
3NmwuyG6OGgPcEww8cPxeXbp+eJFvSDWRQb/cjasz7S0fUykP1XyR+N6ety+pP1Y | ||
n/17NsQvLkPs6ULHPuKHyoCQ/E9p1nLljuBX790mEHA5SrTpWY/tq9vo0LZAuZVF | ||
okmvovIQ7Mp6/w8S+H0XTvowbufJDhBM9c6WkBvsWqPFBYER7Qs2MMzh3/+U8EBs | ||
I1p2ptgRGcw5hQfXGD2gvoS7yYH9hnA0nY7JEq3sV0dsrhLUCeGbe3ZINXZ5VHsL | ||
twvWzP6aPgmh12nx53OXtlvxZJJTKuCz1I8aljjHmXlarkx0Mi/6FvufntxLj21Y | ||
bNFwVmp2Otmc2me5quOLE7koTv3xO2qwdHwkNleVApwbwKYp9LR1bsRfJOa4SynZ | ||
5ifRe2ioV/cAEQEAAYkCNgQYAQgAIBYhBGDtBKznxniVcbZSS7juYhEBcnPqBQJa | ||
MRn3AhsMAAoJELjuYhEBcnPqeYEP/3Bmd6nFifcvMNMFZcwLRHZPGWkJjpfOCFg7 | ||
IsakFdAtscFd9BGDFzPe7LHjXG+WHxepbgGsYecEGjiZDKI/rf/5PD9wqN05hmkM | ||
U0Njaq42FsesfdhLdVh4FAmzqde0qEuTIVX9S2WpNAHrJlQgEZFMXJBH+JagtP2J | ||
301Wr1XpvBeP9mthi3zJFl3Pg+3XK2yHRfqWTn2K7cf8so2ht/Rha77KNskLmt3l | ||
Dstr4Q/Z8QBfIrAFZM5ATCczwevmkKvB/qNtEVKQEAV8rSsSweQ4yGLsJMx3oOKZ | ||
pk7hNDGnWrkbkxpa48nwJLJFoItDAruPVHCsA0CcM1ZehKsEHyxu6iKbEFimVeHz | ||
4WRKEt9wAphH+dJyhNfo7tTTKLB8peV0ImuSBi/yTuBZ/J6Y3MZRiNI6GSxB23cf | ||
bdmI2t2BqTIwyROy9J80n3ejzTwPBXUVepEGz1Nx5G/4hOOkhJCiyNK2zmqL2FA/ | ||
+KZj2l1cct4TK9N+4GN+7oMR6RoflSCP0ujrkZN+Z/SQ97ynmTH43oITUhVbAIWD | ||
+XwL3enSQdnxOuKsbRbBektJbzdxQ2s+HIOPWbWs+FScrb/47ZKEpqWX+6H87i53 | ||
noTcwhv0Bgmktira4zNeBsvgEDP0vo+IHoE6RXJ6FqVyHibqdEdBibK/Aoz0E1Cv | ||
icU8wxhf | ||
=+yeJ | ||
-----END PGP PUBLIC KEY BLOCK----- |