Gong-MFZ-Aware_Pushkar-Kakade_Resubmission-2

Makefile

@@ -0,0 +1,30 @@
+include .env
+
+# export values in .env to be used in the shell scripts
+export $(shell sed 's/=.*//' .env)
+
+default:
+	$(MAKE) build
+
+deps:
+	cd code && npm ci
+.PHONY: deps
+
+build: deps
+	cd code && npm run build
+.PHONY: build
+
+auth:
+	devrev profiles authenticate --org $(DEV_ORG) --usr $(USER_EMAIL) --expiry 7 # days
+
+.PHONY: auth
+
+deploy: auth
+	./code/scripts/deploy.sh
+.PHONY: deploy
+
+# Removes the latest snap-in from the org. This is useful when you want to
+# re-deploy the same snap-in to the same org.
+uninstall:
+	./code/scripts/cleanup.sh
+.PHONY: uninstall

README.md

@@ -1,14 +1,53 @@
-## Partner Workshop Submission
-
-1. Clone this repo: https://github.com/devrev/partner-workshop-submissions
-2. Create a branch locally: git commit -b CustomerName_YourName_ProblemStatementNumber
-3. Add your code folder here.
-4. Commit and Push your code
-5. Raise a PR from your branch to main
-
-Also, Dashboard is part of Snap-in, so it doesn’t need any other code repo.
-Guidelines:
-- You just need to share the code repo with the snap-in. The dashboard should be part of the snap-in only.
-- Screenshots of the setup and documentation are not required.
-- There are no additional requirements.
-- You should put the code in the repo and share it with us.
+# 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](https://developer.devrev.ai/snapin-development/references/cli-install) by following the instructions as per the Operating System.
+
+2\. Install [jq](https://jqlang.github.io/jq/download/).
+
+## Build, Deploy and Run
+
+1\. Create a new repository:
+
+- Create a new repository from this template by clicking the "Use this template" button in the upper right corner and then "Create a new repository".
+- The repository name must start with `airdrop-` (e.g., `airdrop-<external system>-snap-in`).
+
+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:
+
+```bash
+make build
+```
+
+5\. Deploy the Snap-in to the organization:
+
+```bash
+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.

code/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+.env
+extracted_files

code/.npmrc

@@ -0,0 +1 @@
+save-exact=true

code/.prettierignore

@@ -0,0 +1 @@
+dist/**/*

code/.prettierrc

@@ -0,0 +1,15 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "jsxSingleQuote": false,
+  "arrowParens": "always",
+  "proseWrap": "never",
+  "htmlWhitespaceSensitivity": "strict",
+  "endOfLine": "lf",
+  "organizeImportsSkipDestructiveCodeActions": true
+}

code/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],
+    '@babel/preset-typescript',
+  ],
+};

code/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

code/nodemon.json

@@ -0,0 +1,6 @@
+{
+  "execMap": {
+    "ts": "ts-node",
+    "watch": ["src"]
+  }
+}