mirror of https://github.com/status-im/status-react.git synced 2025-01-10 02:56:07 +00:00

Changes:
- Add missing lazy assignment for OS_NAME, fixes double Nix shells
- Moved `scripts/add-nix-gcroots.sh` to `nix/scripts/gcroots.sh`
- Moved Nix package manager setup to `nix/scripts/setup.sh`
- Created `nix/scripts/source.sh` to reuse in all Nix scripts
- Created `STARTING_GUIDE.md` with instructions for contributors
- Created `scripts/colors.sh` for definition of shell colors
- Removed `scripts/setup` in favor of `nix/scripts/setup.sh`
- Removed all of `scripts/lib` since it was useless

Signed-off-by: Jakub Sokołowski <jakub@status.im>

2020-02-24 19:31:55 +01:00

1.7 KiB

Raw Blame History

Description

This document provides information on how to start developing Status App.

Getting Started

To start developing start a shell for platform you are interested in.

make shell TARGET=android

This step will take a while the first time as it will download all dependencies.

To build the app, your can simply run on of the following:

make release-android
make release-ios

For more make targets run make help.

Manual Steps

There are a few manual steps you might want to do in order to start contributing.

Genymotion Virtualization

Optionally set up Genymotion if you don't want to use Android Virtual Device:

https://www.genymotion.com

Android Development Environment

You can also setup Android Development Environment + Simulator:

https://facebook.github.io/react-native/docs/getting-started.html

Configure GitHub Account

The optimal way of pushing to GitHubis using SSH instead of user/pass auth.

It's recommented that you add your public SSH key to your GitHub account.

Configure GPG Keys for signing commits

In order to increase security we require all commits in status-react repo to be signed with a GPG key.

Steps:

1.7 KiB Raw Blame History