Skip to content

Getting Setup

Prerequisites

  1. Download and install Git
    This will be used to download the repository

  2. Download and install Git LFS
    This will be used to download any required binary assets, such as images or pdfs

  3. Download and install Node
    This is the programming language required to run the project. We currently support any of the versions prefixed v20.x.x or v18.x.x

  4. Download and Install Yarn
    This manages all 3rd-party code dependencies

Installation

Download the repo with binary assets

Choosing a location to download the repo

It is best to download the repo to a folder path that does not include any spaces. If using a user documents directory that includes spaces, e.g. /user/my name, you may need to re-open the terminal in a different folder instead.

To download the repo into the current working directory, run: 

git lfs clone https://github.com/IDEMSInternational/open-app-builder.git
Note - if you do a regular git clone, you can always run git lfs fetch --all later to sync assets

Install required dependencies

Navigate to the newly cloned directory if you have not done so already: 

cd open-app-builder

From the route of the project, run the following command to download and install the required dependencies: 

yarn install
Note - you may have to do this from time to time when the code is updated

Configuration

Set Deployment

The app supports using different workspace or deployment configurations. These are stored in .idems_app/deployments

To use an existing deployment, run the following script: 

yarn workflow deployment set
If you have already imported or created a deployment, this will present an interactive list of deployments to select from.

If you have no available deployments, see Deployment Documentation for information about creating and configuring deployments.

Running locally

Start the local server

yarn start
This will start a local server and serve the app in your browser on http://localhost:4200.

Finishing setup

In order to complete the setup process, navigate to the relevant section of the documentation from the options below, and continue with the steps outlined.

For Content Authors

Please see Quickstart Authors

For Developers

Please see Quickstart Developers