Primes.js

Prime Number Generator by Miroslaw Majka

Circle CI Build Status:

Instructions

To run the application please do the following in your favourite CMD:

git clone https://github.com/miroslawmajka/primes-js.git
cd primes-js
npm install

This will allow you to run:

npm run lint
npm run local-test

This will run ESLint and Mocha unit tests against the code along with code coverage.

To run the application you can use one of the following commands:

node index.js -n NUMBER
node index.js --number NUMBER

Where NUMBER is the n-th prime number (whole number).

You can add a .env file with the following contents to the root of this project:

DEBUG=true

This will cause the script to print debugging information about the prime generation.

What's Good

• Circle CI integration which monitors the integrity of the code.
• To generate 1,000,000 primes the algorithm took 26.609 seconds.
• Mocha, NYC, Sinon, Chai, ESLint all doing their parts.

What could be Better

• A better algorithm can be implemented using the Wikibook along with some basic metrics added when running unit tests for very large numbers (e.g. > 1,000,000).
• A web interface could be implemented with an Express package that would show the result in HTML format.
• A tidy up of the logger to have a consistent logger/print module