Advanced Guides & Resources
Sample App
A practical demonstration of integrating Nango in your codebase.
The sample app contains:
- A frontend: lets users connect an integration using the Nango frontend SDK.
- A backend: listens to Nango webhooks and consumes the Nango API to read & write data.
The sample app uses both Slack and Google Drive as example integrations and is showcased in this demo video.
Access the repository
NangoHQ/sample-app
Run the sample app
1
Create an account
- Go to nango.dev and create an account (free).
2
Create a Slack integration
- Go to Integrations and create a Slack integration.
- Go to Slack Dev Center and create a Slack OAuth app with Bot Token Scopes:
users:read
chat:write
- Add
https://api.nango.dev/oauth/callback
as a redirect URL in your Slack OAuth app. - Go back to Nango. In the “Authorization” tab, add credentials in the Slack integration in the
Authorization
tab. In the “Endpoints” tab, activate endpointGET /users
andPOST /send-message
.
3
Create a Google Drive integration
- Go to Integrations and create a Google Drive integration.
- Go to Google Cloud Console and create a new OAuth Client with Redirect URIs:
https://api.nango.dev/oauth/callback
. - Go back to the Google Drive integration in Nango. In the “Authorization” tab, add the credentials:
client_id
: from Google Cloud Consoleclient_secret
: from Google Cloud Console
- Use the
https://www.googleapis.com/auth/drive.readonly
scope. - In the “Endpoints” tab, activate
GET /documents
endpoint.
4
Prepare your env
- Install:
NodeJS
,Docker
. Then run:
- Copy your Nango Secret Key, found in Environment Settings.
- Create a file to store environment variables and fill in the Nango Secret Key:
5
Transfer Nango webhooks locally
- This command should be running at all time:
- Copy the URL the command gave you and go to Environment Settings. Set Webhook URL to
${URL}/webhooks-from-nango
, e.g:https://tame-socks-warn.loca.lt/webhooks-from-nango
.
6
Launch
7
Bonus: Deploy custom scripts
This above sample app uses pre-built integrations, but you can also use custom ones.
- Set up the Nango CLI:
- Add your Nango Secret Key in NANGO_SECRET_KEY_PROD in
./nango-integrations/.env
. - Optionally customize the integration using this guide.
- Deploy the custom integration:
Questions, problems, feedback? Please reach out in the Slack community.