Prerequisites
- Node.js backend service where the SDK will be installed
- All packages used are present in the “Supported technologies” list below
- Dev/staging environment for initial rollout (recommended)
Supported technologies
- HTTP/HTTPS: All versions (Node.js built-in)
- GRPC:
@grpc/[email protected](Outbound requests only) - PG:
[email protected],[email protected]–3.x - Firestore:
@google-cloud/[email protected] - Postgres:
[email protected] - MySQL:
[email protected] - IORedis:
[email protected] - Upstash Redis:
@upstash/[email protected] - GraphQL:
[email protected]–16.x - Prisma:
[email protected] - JSON Web Tokens:
[email protected]–9.x - JWKS RSA:
[email protected]–3.x
Setup
1. Install the Tusk CLI
- Linux/macOS
- Windows
2. Create the Tusk Drift config
Runtusk init in CLI to create your .tusk/config.yaml in the root of your service:
“Service” here usually refers to where your
package.json lives..tusk directory and config file if you’d prefer. See the configuration doc for details.
3. Install and initialize SDK
- npm
- yarn
- CommonJS Applications
- If you use TypeScript, your application is likely compiled to CommonJS before running, follow these CommonJS instructions.
- ESM Applications
- If your application’s compiled code uses
importor you do not compile your code, follow these ESM instructions.
- If your application’s compiled code uses
- Next.js Applications