g2i-local

This project provides a local, offline-first development environment for the G2i platform.

Prerequisites

You need to be authenticated with our organization on GitHub Package Registry. Here's a guide from @DevanB on how to do that.

CLI

Usage: g2i-local [options] [command]

Options:
  -h, --help       display help for command

Commands:
  start [options]  Start a local G2i environment. This will pull down the latest staging database if you don't already have a clone.
                   If you'd like to start one anew, use the --wipe flag.
  stop             Stop your local G2i environment.
  destroy          Delete your local G2i environment.
  help [command]   display help for command

Getting Started

To get started with zero setup, run npx -p @g2i/local g2i-local start.

:warning: On the first run, this project imports our staging database which can take a really long time. It only does this on the first run, or whenever you decide to recreate your clone.

Recreating your clone

Use the g2i-local destroy command to delete your local clone, and run g2i-local start again to bring it up from scratch.

Contributing

To setup a local development environment against which you can test changes to the... local development environment, follow these steps.

1. Clone this repo. (git clone)
2. Navigate into its folder. (cd local)
3. Update the code.