Skip to content

Getting Started

Jump to bottom
Trevor Rife edited this page Jul 25, 2023 · 7 revisions

Install

Option 1: Android Studio

  1. Install Android Studio: https://developer.android.com/studio/install
  2. Start Android Studio, then use the toolbar to select File -> New -> Project from Version Control
  3. Enter https://github.com/PhenoApps/Field-Book.git
  4. Android Studio will clone Field-Book into its AndroidStudioProjects directory, and then prompt to open it in the existing window or in a new window.
  5. Once opened, Field-Book can be explored using the navigation bar, edited in the editor window, and built via the build menu in the toolbar.

Option 2: Command Line

Install prerequisites:

  • git (in order to clone the repository)
  • Java Development Kit (JDK) (in order to compile the java source code)

Clone the Field-Book repository:

git clone https://github.com/PhenoApps/Field-Book.git

Explore and edit the project using your preferred editor. Build the project using:

./gradlew build

Architecture

Documentation

The reStructuredText (.rst) files and images in this directory on the docs directory are used to assemble the user documentation. Anytime they are updated, a new Read the Docs build is generated and published to docs.fieldbook.phenoapps.org

Database

Field-BookSchema Interactive schema on dbdiagram.io

Developer Documentation

Clone this wiki locally