Get Started
Sample application
Learn how to integrate Nango using our sample application.
The sample app is a practical demonstration of integrating Nango in your codebase. It 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 Slack as an example integration 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 ans create a Slack integration.
- Go to Slack Dev Center and create a Slack OAuth app with Bot Token Scopes:
users:read
chat:write
- 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
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:
4
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
.
5
Launch
6
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
. - Optionalyl customize the integration using this guide.
- Deploy the custom integration:
Questions, problems, feedback? Please reach out in the Slack community.
Was this page helpful?