Skip to content
This repository has been archived by the owner on Mar 17, 2024. It is now read-only.

Latest commit

 

History

History
102 lines (53 loc) · 2.35 KB

BUILDING.md

File metadata and controls

102 lines (53 loc) · 2.35 KB
Raw

Building Cartographer

HIC SUNT DRACONES

Note: Cartographer is a very early work in progress, so approach with caution. For the moment, development on Windows 10 and 11 is not supported.

Requirements

Building and running Cartographer requires:

  • macOS (for iOS and Android) or Linux (Android only)
  • An iPhone or iPad running iOS 10+
  • An Android device running 8+

If you haven't already, install React Native and it's dependencies.

Install and Configure

  1. git clone git@github.com:localhost-international/cartographer.git
  2. cd cartographer
  3. yarn

Now, make a copy of ./environments/.env.example.ts to a new file named ./environments/.env..ts.

  1. Create a new Etherscan API key
  2. Add the above as the key value of ETHERSCAN_API_KEY in the newly created .env.development.ts
  3. Add a wallet address as a 42 character base16 string or ENS name as the value of ETH_WALLET_ADDRESS

 

Building for iOS and iPadOS

Building React Native on iOS requires:

  • macOS
  • CocoaPods: gem install cocoapods
  • Ruby FFI (Foreign Function Interface): gem install ffi

Build

  1. npx pod-install ios
  2. npx react-native run-ios

Build on a connected device

  • yarn global add ios-deploy
  • npx react-native run-ios --device "Your Device Name"

Building for Apple Silicon

When building with an M1 processor, use the following:

  • Install CocoaPods with: sudo arch -x86_64 gem install cocoapods
  • Install ffi with: sudo arch -x86_64 gem install ffi
  • (Re-)install project dependencies: arch -x86_64 pod install

 

Building for Android

Cartographer is currently in development and is being optimised for iOS/iPadOS.

Leave a comment on the Android Support issue so I know you're interested in an Android compatibility/release.

Building Cartographer for Android requires:

  • macOS or Linux
  • Android Studio 4.0+
  • OpenJDK 8.

Build

  1. npx react-native run-android

 

Building for other platforms

Cartographer is currently only officially supported on Android and iOS, but can be built and run on the following platforms:

  • macOS (via Catalyst)
  • Windows 10 (UWP)
  • Windows 11 (UWP or Android)