ID.me Demo App & Heroku Onboarding

This application demonstrates how to set up and deploy an ID.me integration using Heroku. Follow the steps below to configure, set up, test, and deploy the application.

Prerequisites

Configure sandbox integration

1. Create an Organization.
2. Within your Organization, create a Consumer with:
   • Type set to OAuth
   • Sandbox Mode should be unchecked
   • Click Add Redirect URI and input http://localhost:5001/callback
3. Within your Organization, create an ID.me Social Login/NIST IAL1/AAL1 Policy following the playbook.
4. Copy your Client ID and Client Secret for future use.

Clone this repository

1. Prepare your app by cloning the repository:

   git clone https://github.com/IDme/demo-app
   cd demo-app

Check dependences

1. Check node version and ensure you are using version 18 or later:

   node --version

2. Check npm is installed by Node:

   npm --version

3. Check git version to confirm git is installed:

   git --version

4. Check heroku version to confirm heroku is installed:

   heroku --version

Setup Heroku app

1. Log into Heroku CLI (VPN must be turned off for this step):

   heroku login

   You will be prompted to sign into Heroku and redirected back to your terminal after successfully authenticating.

2. Initialize your git repository with Heroku:

   heroku git:remote -a <your Heroku app name>

Setup demo app

1. Install the necessary dependencies:

   npm install

2. Create a .env file in the root directory of your project and add the following environment variables:

   SANDBOX_CLIENT_ID=<your ID.me Sandbox Client ID>
   SANDBOX_CLIENT_SECRET=<your ID.me Sandbox Client Secret>
   PRODUCTION_CLIENT_ID=<your ID.me Production Client ID>
   PRODUCTION_CLIENT_SECRET=<your ID.me Production Client Secret>
   

Set up environment variables in Heroku

1. Set the environment variables in Heroku:

   heroku config:set SANDBOX_CLIENT_ID=<your ID.me Sandbox Client ID>
   heroku config:set SANDBOX_CLIENT_SECRET=<your ID.me Sandbox Client Secret>
   heroku config:set PRODUCTION_CLIENT_ID=<your ID.me Production Client ID>
   heroku config:set PRODUCTION_CLIENT_SECRET=<your ID.me Production Client Secret>

Testing the application locally

1. Run the application locally to ensure everything is set up correctly:

   npm start

2. Open your browser and navigate to http://localhost:5001 to test the application.

Deploy your application to Heroku

1. Commit your code to git and deploy to Heroku using git:

   git add .
   git commit -a -m "make it better"
   git push heroku master

Your application should now be deployed to Heroku and accessible via your Heroku app URL.