Contributes

You can run Nango locally with Docker (step-by-step guide), contribute an API (step-by-step guide) and contribute an integration template (step-by-step guide).

Develop locally

To develop on the platform locally follow those steps:

git clone https://github.com/NangoHQ/nango.git

Install the project

npm i

Set your envs

cp .env.example .env

Launch the databases and queue

npm run dev:docker

Launch Nango

# In two different shell
npm run dev:watch
npm run dev:watch:apps

Start by creating a folder that will contains your integrations

mkdir nango-integrations
cd nango-integrations

Install the CLI

npm i -g nango

nango init

Change the .env file NANGO_SECRET_KEY_DEV and NANGO_HOSTPORT. And deploy your changes

nango deploy dev

To know more about the CLI, check the documentation.

Pull Request title should follow Conventional Commits