Development Setup

Setting up locally

AIP is developed using Node JS and React. To get started, ensure you have Node JS installed on your computer. We recommend using nvm to manage multiple versions of Node.

1. Setup nvm and Node

• Setup nvm, follow the guide here
• Clone this repo git clone https://github.com/developmentseed/catalyst-aip.git
• Change directory into the repo. cd catalyst-aip
• Setup the appropriate node version by running nvm install

2. Install dependencies

• yarn install

3. Add the environment variables

• The .env.example file is a sample for the environment variable necessary to run the application.
• cp .env.example .env.development to use with yarn develop
• cp .env.example .env.production to use with yarn build — see the Deploying section.

4. Start the application

• yarn develop and visit http://localhost:8000

Deploying

Currently, the application is automatically deployed to a service called Surge. Surge is a simple way to publish websites directly with a single command. This is setup using Github Actions. Any commit to the main branch will deploy the application.