A system that sends out a daily tip sheet for fact checkers, developed at the Duke Reporters Lab.
This is a node project, to set up your development environment...
> yarn install
This project uses postgres to store its data. You will need to either set up a local copy, or find a hosted solution.
This project uses redis as a data store for queues. You will need to set up a local copy, or find a hosted solution.
You will need to configure your environment variables. In production this can be done however your host recommends; in development we recommend using an .env file. A template for the contents of .env is provided in .env.template.
> cp .env.template .env
> vi .env
> yarn migrate
> yarn start
> yarn test
Or, to start a watcher that runs tests as you change them:
> yarn test:watch
The primary control flow of this project is handled through jobs and queues. We use bull, which is built on top of redis.
Creating a new queue involves making a new directory in the server/queues folder with the following files:
- Job Processor :: The job processor is the code that is run whenever a new item (job) is added to the queue. It takes in job information, does work, and registers the completion of the job. This must export a function that will be called on a job process.
- Job Scheduler :: The job scheduler determines how often jobs are regularly added to this queue. The possible frequency constants are described in
src/server/queues/constants.js. This file must export a class that extends AbstractJobScheduler. - Queue Factory :: The queue factory points to the processor file and names the queue. This must export a class that extends AbstractQueueFactory.
- index (aka the "Queue Dict") :: This just returns instantiated versions of the components decribed in this list. This must export an object with factory, scheduler, and processor attributes.
The best thing to do is look at an existing implemented queue and work from there.
If you're interested in contributing to this project: thank you! Contributions are made via pull request. Please be sure to review our contribution guidelines and code of conduct.