Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 2.28 KB

README.md

File metadata and controls

48 lines (31 loc) · 2.28 KB
Raw

🔥 LIT Scheduled Tasks 🔧

This repo provides scaffolding for running internal scheduled tasks on a CRON-like schedule.

❌ Installation

Packages in this repository are currently not published to NPM; it is expected to be deployed as a worker to Heroku.

🎮 Usage

To prepare for either production usage or local development, you must install dependencies and build the packages.

pnpm install && pnpm build

For local development:

Note that local development uses dotenvx to load necessary environment vars from a .env file which must be located in the root directory of the repository to be loaded.

pnpm dev

For production:

Note that all environment variables for the worker process must be defined in the host environment. Production does not use dotenvx.

pnpm start

📦 Packages

Package Purpose
lit-task-client Load and validate mongo credentials from env in a type-safe way, and produce a task client Agenda instance
lit-task-auto-top-up Task to mint capacity credit NFTs for a list of recipient addresses defined in JSON at a configured URL

💻 Development

The repository is a mono-repo leveraging pnpm as the package manager, using pnpm workspaces. It requires Node v18+, it is recommended that you use nvm to select the correct node version via the included .nvmrc file.

  • Clone the repository
  • Enable Corepack using corepack enable
  • Install dependencies by executing pnpm install in the root of the repo
  • Build all packages by executing pnpm build in the root of the repo
  • Currently, you must manually rebuild packages that are referenced locally using workspace:* references after making changes, until unbuild stub issues with Typescript have been resolved. Reference issue: unjs/unbuild#370