ADaaS Template

This GitHub repository provides a template with example code to implement an Airdrop as a Service (ADaaS) Snap-in .

Prerequisites

1. Install DevRev CLI by following the instructions as per the Operating System.

2. Install jq.

Build, Deploy and Run

1. Clone Repository:

• Either clone this repository or create a new repository from it by clicking the "Use this template" button above.
• Set the desired repository name for your own copy (e.g., <organization>-<external system>-adaas).

2. Open the project in your IDE and set up project environment variables, by following these steps:

• Rename .env.example to .env.
• In .env set the slug of your organization, and your email.

4. Build the Snap-in using the following command:

make build

5. Deploy the Snap-in to the organization:

make deploy

NOTE: This process may take some time. Command authenticates you to the org using the DevRev CLI, creates a Snap-in package, its Snap-in version, and finally the Snap-in draft.

6. After the Snap-in draft is created, install the Snap-in in the DevRev UI (Settings -> Snap-ins -> Install snap-in).

7. Start the import (Imports -> Start import -> <your Snap-in>).

Common Pitfalls

Q: Conflict error after the Creating snap-in package... output during make deploy.

A: Snap-in package with the same slug already exists. Override the `SNAP_IN_SLUG` variable by explicitly updating the variable in `scripts/vars.sh`.

Q: Snap-in version build/deployment failed after the Waiting for snap-in version to be ready... message

A: The snap-in version could not be built. Check the logs by running the DevRev CLI command `devrev snap_in_package logs`. For prettier UI, pipe the output to `jq`

Q: Token is expired when deploying or cleaning up.

A: Authentication token to the `DEV_ORG` has expired. Run `make auth` to reconnect to the organization.