pangea

Bitnation's Blockchain Jurisdiction

Table of Contents

• Security
• Install
• Usage
• API
• Maintainers
• Project Boards
• Contribute
• License

Security

If you find a bug / vulnerability please DO NOT open an issue. Write to security@bitnation.co PLEASE use this PGP key to encrypt your report / email.

Install

Requirements

• Node 8.x - Node 10+ is not supported by realm yet.

• Android Studio 3.1+ (If NDK is not installed, this version requirement may be more relaxed).

• Panthalassa binary, also covered below in instructions.

Supported Operating Systems: MacOS, Linux (Android only).
Windows is unsupported, but may work. Please open a well-documented issue anyway if you have problems building under Windows.

Project setup

1. Clone the repo
2. Run npm install
3. Copy .env.dev.example to .env. Set PRODUCTION to true/false.
4. Copy .dev.config.default.yaml to .dev.config.yaml, and change any necessary values.
5. Run ./scripts/check.env.sh to determine if you are missing anything. This is still a new script, so there could be false negatives.

IOS specific 1. Get cocoapods 2. Go to the ios folder 3. Run pod install 4. Place a compiled version of https://github.com/Bit-Nation/panthalassa into ios/Frameworks/panthalassa.framework 5. Go back to the project root and run npm run ios

Android specific 1. Place a compiled version of https://github.com/Bit-Nation/panthalassa into android/panthalassa/panthalassa.aar 2. Run npm run android 3. Run npm run android:log (requires lnav) to view runtime logs.

Usage

Git & best practice

• We use this branching model. Make sure to read it.
• PLEASE prefix your commits with a topic like this: [git] blacklisted .idea
• Write tests for your code

API

If you would like to develop a DApp for Pangea please checkout this part of the documentation

Maintainers

Susanne Tarkowski Tempelhof
Mark Nuzz (mark@bitnation.co)

Project Boards

We use PivotalTracker for project management. As of 12/7/2018, our primary board is open to the public.
App - https://www.pivotaltracker.com/projects/2204148
Architecture - https://www.pivotaltracker.com/projects/2213396

Contribute

PRs are accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2018 Bitnation