Skip to content

Commit fb6ad5b

Browse files
committed
docs: improve BUILD.md and DEVELOPMENT.md
1 parent 7738a18 commit fb6ad5b

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

BUILD.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Building Bitkit from source
22

3+
These instructions are for building Bitkit from source to get a production version of the app. If you are looking for the latest release, you can download it from the [App Store](https://testflight.apple.com/join/lGXhnwcC) or [Google Play](https://play.google.com/store/apps/details?id=to.synonym.bitkit.wallet) or get the latest APK from the [releases page](https://github.com/synonymdev/bitkit/releases).
4+
5+
## Requirements
6+
7+
Make sure you have [setup your environment for React Native](https://reactnative.dev/docs/environment-setup).
8+
9+
> [!NOTE]
10+
> Not all of the steps outlined in the above link may be required for building the app. You can skip the ones not relevant to you.
11+
312
## Setup
413

514
1. Clone the repository
@@ -10,33 +19,26 @@ git clone [email protected]:synonymdev/bitkit.git && cd bitkit
1019

1120
2. Switch Node version
1221

13-
Switch to the Node.js version defined in `.nvmrc`. If `nvm` (or similar) is installed on your system you can run `nvm use`.
22+
Switch to the Node.js version defined in `.node-version`. You can visit [.node-version File Usage](https://github.com/shadowspawn/node-version-usage) and use one of these methods to change the node version you need.
1423

1524
3. Install dependencies
1625

1726
```shell
1827
yarn install
1928
```
2029

30+
4. Set environment variables
31+
32+
```shell
33+
cp .env.production.template .env.production
34+
```
35+
2136
## Build
2237

2338
### iOS
2439

25-
For iOS: Open the `ios` folder in Xcode to build the project.
40+
Follow instructions from the [React Native docs](https://reactnative.dev/docs/publishing-to-app-store) for iOS.
2641

2742
### Android
2843

29-
For Android: `yarn bundle`.
30-
31-
Moreover, to build the Android APK, it is necessary to configure a signing store to sign
32-
the apk, as explained by [React Docs](https://reactnative.dev/docs/signed-apk-android).
33-
34-
It is recommend to use the already presented `debug.store` in `android/app`.
35-
Add the following lines to `~/.gradle/gradle.properties`:
36-
37-
```shell
38-
BITKIT_UPLOAD_STORE_FILE=debug.keystore
39-
BITKIT_UPLOAD_STORE_PASSWORD=android
40-
BITKIT_UPLOAD_KEY_ALIAS=androiddebugkey
41-
BITKIT_UPLOAD_KEY_PASSWORD=android
42-
```
44+
Follow instructions from the [React Native docs](https://reactnative.dev/docs/signed-apk-android) for Android. After that you can find the `.aab` under `android/app/build/outputs/bundle/release/app-release.aab` which can be installed on your device.

DEVELOPMENT.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Development
22

3+
This document describes how to setup your environment to build Bitkit for development and to run automated tests. If you just want to build it from source for normal usage, see [BUILD.md](./BUILD.md).
4+
5+
## Requirements
6+
37
Make sure you have [setup your environment for React Native](https://reactnative.dev/docs/environment-setup).
48

59
## Installation

0 commit comments

Comments
 (0)