@opengovsg/create-ogp-app

Create OGP App

Create OGP App is a tool to quickly bootstrap and deploy an app in AWS.

Getting Started

Prerequisites

• Github Personal Access Token
  • Generate your token
  • Github documentation
  • Required scopes: repo,workflow
• AWS CLI credentials setup in bash env
  • You should be able to run aws sts get-caller-identity and get your account ID.
  • Make sure your region is set to ap-southeast-1
• Pulumi client is installed

brew install pulumi/tap/pulumi

Creating your app

• Clone and link the repository

git clone [e-mail]:opengovsg/create-ogp-app.git
npm install
npm link

• Create your app (for example my-new-app or mna within the team my-new-app-team). The process will:
  1. Bootstrap your AWS account by setting up github ODIC (for github actions to access your AWS account).
  2. Create a new repo in opengovsg/<name>-infra for infra code, and open/opengovsg/<name> for your application code.
  3. Spin up the initial infrastructure to launch a baseline app with a Github Action in the infra repository.

$ create-ogp-app my-new-app

> @opengovsg/create-ogp-app@0.1.0 start
> node dist/cli.js my-new-app

👷 Creating application my-new-app
? Short app name (no more than 10 characters, e.g.: `sk` for `starter-kit`): mna
? Team name: my-new-app-team
? Choose the template for your application: ts-template
? GitHub Personal Access Token: ****************************************
✔ Logged in to GitHub as *****
✔ Successfully detected valid AWS Credentials
✔ You are logged in as *************** in AWS Account ID **********
? Are you sure you want to create your project in this AWS Account Yes
✔ Pulumi plugins installed
? Proceed to bootstrap infrastructure Yes

... this will take a while to complete

• TODO: How to clean up all created resources