Skip to content

FEMUGPE/femug-lottery

Repository files navigation

Lottery

Select a random person from json.

How to install

Verify if you have node and npm installed.

$ npm install -g femug-lottery

Command Line Usage

Random

$ lottery you-list.json

Show the project version.

$ lottery --version

Development

Code Style

Follow the Banana NodeJS style guide.

Validate the code style with ESLint:

$ npm run eslint

Code Docs

Generate code docs with JSDocs

$ npm run jsdocs

View code docs in out/index.html

Tests

Run the unit tests with mocha:

$ npm test

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Find on our issues the next steps of the project ;)
Want to contribute? Follow these recommendations.

History

See Releases for detailed changelog.

License

MIT License © FEMUGPE