dce-dev-wizard/README.md

Wizard for managing development apps at Harvard DCE.

# dce-dev-wizard

Wizard for managing development apps at Harvard DCE.

## Quick Start

Install the wizard into your project:

`npm i --save-dev dce-dev-wizard`

Add a `dceConfig.json` file to the root folder of your project that contains all existing deployments (caccl-deploy services):

```json
{
  "dbName": "immersive-player-store",
  "deployments": [
    {
      "name": "Stage",
      "app": "courseadmintools-stage",
      "profile": "stage"
    },
    {
      "name": "Prod",
      "app": "courseadmintools",
      "profile": "prod"
    }
  ],
  "relatedClusters": [
    {
      "name": "Opencast Dev 10",
      "cluster": "opencast-ecs-immersive"
    }
  ]
}
```

Where "deployments" is an array of existing caccl-deploy services. "name" is a human-readable name/description of the deployment, "app" is the caccl-deploy app name, and "profile" is the aws profile associated with accessing that service.

In your `package.json`, add to the end of your top-level build script:

`"build": "[...] && npm explore dce-dev-wizard -- npm run build-error-docs"`

Whenever you build, we will then update your error docs in the `/docs` folder.