Enframe

Remaining Features to Complete

1. Ensure idempotency

2. lint

3. palantir/tslint-react

4. Service worker

5. deploy to app stores?

6. Investigate post-heroku deploy steps. I.e., automated custom domain setup via heroku CLI? Automated domain registration (far-fetched)?

7. Programmatic index.html generation?

8. introduce psql

9. introduce Redux

10. introduce integration tests

Before enframing

• Ensure you have stored your Gitlab SSH key on your dev machine.
• Ensure you have the Heroku CLI on your dev machine.

Steps

1. Create a new app.

   mkdir new-app
   cd new-app

2. Add an enframe.json file.

   {
     "appName": "new-app",
     "gitlabRemoteSSH": "[email protected]:username/new-app.git"
   }

3. Add and execute enframe.

   yarn add --dev enframe
   yarn enframe

Notes

• A $HEROKU_API_KEY needs to be stored in your Gitlab project in order for your gitlab-ci.yml file to deploy to Heroku successfully. It is in Heroku User Settings. Copy it into Gitlab under Settings -> CICD -> Variables. Until you do this, the deploy steps will fail.
• The Gitlab project does not need to exist before you set it as an upstream. Gitlab can create the project for you on first push.