Skip to content
This repository has been archived by the owner on May 16, 2024. It is now read-only.

Latest commit

 

History

History
72 lines (48 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 1.19 KB

Contributing

Requirements

  • Mage: install via brew install mage
  • Go 1.19.6
  • NodeJS
  • pnpm: install via brew install pnpm

Note: you can alternatively run mage natively with Go with go run mage.go.

Getting started

  1. Install NodeJS dependencies..

    pnpm install
  2. Assume an AWS role with permission to create resources.

    assume cf-dev
  3. Build the gdeploy CLI.

    make gdeploy
  4. Deploy the development stack.

    mage -v deploy:dev
  5. Set up some users in Cognito.

    gdeploy identity users create --admin -u [email protected]
    gdeploy identity users create -u [email protected]
  6. Open the web dashboard.

    gdeploy dashboard open

Tearing down

To clean up a deployment run:

mage -v destroy

Cloud Development

You can deploy to AWS with hot-reloading as follows. Deployments are very fast (currently around 15-30s):

mage -v watch

Documentation