Quick Start Guide
This guide will help you quickly set up Sidequest.js in your Node.js application.
To install Sidequest.js, check out Installation Guide. If you are strictly following this quick start, you should install the SQLite backend driver, which is the default backend for Sidequest.js.
2. Job Creation
The first step is to create a Job class. This class will define the job's behavior and can be customized as needed.
typescript // jobs/EmailJob.js import { Job } from "sidequest" ; export class EmailJob extends Job { async run ( to , subject , body ) { console. log ( `Sending email to ${ to }: ${ subject }` ); // Your email sending logic here return { sent: true , timestamp: new Date () }; } }
3. Sidequest Startup
The next step is to configure and start the Sidequest engine. You can use the default settings or customize it according to your needs.
typescript // app.js import { Sidequest } from "sidequest" ; // Quick start Sidequest with default settings and Dashboard enabled await Sidequest. start (); console. log ( "Sidequest started! Dashboard: http://localhost:8678" );
4. Enqueue Jobs
... continue reading