Starter project

To scaffold a new application from this template run:

npx degit https://github.com/sketchmonk-dev/data-exporter-starter.git <YOUR_APP_NAME>

• Add your Activity Definitions to src/activities.ts.
• Add your Workflow Definitions to src/workflows.ts.
• Set your task queue name in src/shared.ts.
• Modify the src/client.ts file and replace YOUR_WORKFLOW with the name of your Workflow.
• Add Activity and Workflow tests to the src/mocha directory in files with the extension .test.ts.

Utilities

• utils/mongodb: Utilities for mongodb connection
• utils/csv-writer: A utility class for writing records to CSV
• utils/mailer: Utilities for sending mail with attachments
• utils/storage: Utilities to work with AWS S3 storage
• utils/notification: Utilities for sending notifications using the Novu platform.

Running the code

Install dependencies with npm install.

Run temporal server start-dev to start Temporal Server.

The package.json file contains scripts for running the client, the Worker, and tests.

1. In a shell, run npm run start.watch to start the Worker and reload it when code changes.
2. In another shell, run npm run workflow to run the Workflow Client.
3. Run npm run format to format your code according to the rules in .prettierrc.
4. Run npm run lint to lint your code according to the rules in eslintrc.js.
5. Run npm test to run the tests.