Add instructions to fork authored by Doris Tam's avatar Doris Tam
......@@ -12,7 +12,9 @@
- [Android development environment](#android-development-environment)
- [Set up through Jetbrains Toolbox (Option 1)](#set-up-through-jetbrains-toolbox-option-1)
- [Manual setup (Option 2)](#manual-setup-option-2)
- [Clone project into your local directory](#clone-project-into-your-local-directory)
- [Make a copy of the project](#make-a-copy-of-the-project)
- [Forking the github repository (community contributors)](#forking-the-github-repository-community-contributors)
- [Clone project into your local directory (maintainers)](#clone-project-into-your-local-directory-maintainers)
- [Install and start the app](#install-and-start-the-app)
- [Run the app on a device/emulator](#run-the-app-on-a-deviceemulator)
- [Virtual device testing - on Emulator with Android studio](#virtual-device-testing---on-emulator-with-android-studio)
......@@ -154,7 +156,13 @@ Setting up your development environment can be somewhat tedious if you're new to
> Please make sure you use the correct Android SDK path. You can find the actual location of the SDK in the Android Studio "Preferences" dialog, under **Appearance & Behavior** → **System Settings → Android SDK.**
## Clone project into your local directory
## Make a copy of the project
### Forking the github repository (community contributors)
You will need to make a [fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) of <https://github.com/MaharaProject/mahara-mobile-react-native> to your own github account.
### Clone project into your local directory (maintainers)
1. In your terminal navigate into the desired folder to place the project.
2. In the folder where you want to clone the project into, execute the command
......@@ -167,6 +175,8 @@ Setting up your development environment can be somewhat tedious if you're new to
## Install and start the app
> 🌐 If you are a translator, the following steps are optional if you'd like to install the app to see your changes.
1. To enter the project folder execute the next command:
```bash
......@@ -259,6 +269,7 @@ Now that we have gotten Mahara mobile installed and ready to run, let's start co
[Let's contribute!!! 💡](https://git.mahara.org/mahara-mobile/mahara-mobile-react-native/-/wikis/Contributing-to-Mahara-mobile)
# Troubleshooting
Changes made but not seeing anything different?: Try cleaning the cache in Gradle with `cd android && ./gradlew clean`
Virtual device open but app not running? You might need to install adb with:
......
......