Skip to the content.

Table of contents

  1. Getting started
  2. What’s a Job/Batch/Pipeline
  3. Running the server
  4. Creating a worker
  5. The GNJ API
  6. Plugin the server to your express
  7. Q&A
  8. Contributing

Install the development environment

apt-get install git curl yarn
# or
brew install git curl yarn

node & npm & yarn

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.2/install.sh | bash
nvm install 12
nvm use 12

Get the project

git clone git@github.com:teamstarter/node-jobs.git
cd node-jobs
yarn
yarn start

Be able to run bin files from the local node_modules folder

vim ~/.bashrc
#Add at the end of the file:
alias npm-exec='PATH=$(npm bin):$PATH'
npm-exec
:wq #Then save and quit
source ~/.bashrc

Test the migration script locally

yarn run gnj migrate ./../tests/sqliteTestConfig.js

Start a test server using the test database migrated previously

yarn start

Running the test

yarn test

Debugging a specific test

node --inspect-brk ./node_modules/jest/bin/jest.js ./tests/job.spec.js

Previous: Q&A


Teamstarter’s other libraries