mirror of
https://github.com/aliasvault/aliasvault.git
synced 2026-03-19 07:07:59 -04:00
82 lines
1.9 KiB
Markdown
82 lines
1.9 KiB
Markdown
---
|
|
layout: default
|
|
title: Build from Source
|
|
parent: Android App
|
|
grand_parent: Mobile Apps
|
|
nav_order: 1
|
|
---
|
|
|
|
# Building AliasVault Android App from Source
|
|
|
|
This guide explains how to build and install the AliasVault Android app from source code using React Native.
|
|
|
|
## Prerequisites
|
|
|
|
- MacOS or Windows machine with Android Studio installed
|
|
- Git to clone the repository
|
|
|
|
## Building the Android app
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://github.com/lanedirt/AliasVault.git
|
|
```
|
|
|
|
2. Navigate to the mobile app directory:
|
|
```bash
|
|
cd AliasVault/apps/mobile-app
|
|
```
|
|
|
|
3. Install JavaScript dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
4. Install and build Android dependencies:
|
|
```bash
|
|
cd android
|
|
./gradlew assembleRelease
|
|
```
|
|
|
|
5. Deploy release build to your device:
|
|
|
|
For MacOS, install adb to deploy the app to a phone or simulator via command line:
|
|
```bash
|
|
# Install adb
|
|
brew install android-platform-tools
|
|
|
|
# List devices (physical devices connected via USB and any running simulators)
|
|
adb devices
|
|
|
|
# Deploy to chosen device
|
|
adb -s [device-id] install android/app/build/outputs/apk/release/app-release.apk
|
|
```
|
|
|
|
6. For publishing to Google Play:
|
|
Create a local gradle file in your user directory where the keystore credentials will be placed
|
|
```bash
|
|
nano ~/.gradle/gradle.properties
|
|
```
|
|
|
|
Input the following contents and input the correct password:
|
|
|
|
```bash
|
|
ALIASVAULT_UPLOAD_STORE_FILE=aliasvault-upload-key.keystore # Path to the keystore file
|
|
ALIASVAULT_UPLOAD_KEY_ALIAS=aliasvault-key-alias # Replace with value of the `keystore.keyAlias`
|
|
ALIASVAULT_UPLOAD_STORE_PASSWORD=***** # Replace with the password to the keystore
|
|
ALIASVAULT_UPLOAD_KEY_PASSWORD=***** # Replace with the password to the keystore
|
|
```
|
|
|
|
Then create the bundle for upload to Google Play:
|
|
|
|
```bash
|
|
cd android
|
|
./gradlew app:bundleRelease
|
|
```
|
|
|
|
The resulting .aapb file will be available in:
|
|
|
|
```bash
|
|
app/build/outputs/bundle/release
|
|
```
|