1 | # Chance
|
2 |
|
3 | [![Chance Logo](http://chancejs.com/logo.png)](http://chancejs.com)
|
4 |
|
5 | [![Build Status](https://travis-ci.org/chancejs/chancejs.svg?branch=develop)](https://travis-ci.org/chancejs/chancejs) [![GitHub license](https://img.shields.io/github/license/chancejs/chancejs.svg)](https://github.com/chancejs/chancejs) [![GitHub stars](https://img.shields.io/github/stars/chancejs/chancejs.svg)](https://github.com/chancejs/chancejs) [![npm](https://img.shields.io/npm/dm/chance.svg)](https://npmjs.com/package/chance) [![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/chance/badge?style=rounded)](https://www.jsdelivr.com/package/npm/chance) [![npm](https://img.shields.io/npm/v/chance.svg)](https://npmjs.com/package/chance) [![Coverage Status](https://coveralls.io/repos/chancejs/chancejs/badge.svg?branch=master)](https://coveralls.io/r/chancejs/chancejs?branch=master) [![awesomeness](https://img.shields.io/badge/awesomeness-maximum-red.svg)](https://github.com/chancejs/chancejs)
|
6 |
|
7 | Chance - Random generator helper for JavaScript
|
8 |
|
9 | Homepage: [http://chancejs.com](http://chancejs.com)
|
10 |
|
11 | Many more details on [http://chancejs.com](http://chancejs.com) but this single
|
12 | library can generate random numbers, characters, strings, names, addresses,
|
13 | dice, and pretty much anything else.
|
14 |
|
15 | It includes the basic building blocks for all these items and is built on top
|
16 | of a Mersenne Twister so it can generate these things with repeatability, if
|
17 | desired.
|
18 |
|
19 | ## Usage
|
20 |
|
21 | See the [full docs](https://chancejs.com) for details on installation and usage.
|
22 |
|
23 | ## Dependent tools
|
24 |
|
25 | * [Chance CLI](https://github.com/chancejs/chance-cli) - Use Chance on the command line.
|
26 | * [Chance Token Replacer](https://github.com/drewbrokke/chance-token-replacer) - Replace tokens in a string with Chance generated items.
|
27 | * [Dream.js](https://github.com/adleroliveira/dreamjs) - Lightweight json data generator
|
28 | * [Fake JSON Schema](https://github.com/pateketrueke/json-schema-faker/) - Use chance generators to populate JSON Schema samples.
|
29 | * [Mocker Data Generator](https://github.com/danibram/mocker-data-generator/) - Minimal JSON data generator.
|
30 | * [swagger-mock-api](https://github.com/dzdrazil/swagger-mock-api/) - Generate API mocks from a Swagger spec file enriched with Chance types and constraints
|
31 | * [fony](https://github.com/captainsafia/fony) - A simple command line tool for generating fake data from a template string
|
32 |
|
33 | Or [view all of the dependents on npm](https://www.npmjs.com/package/chance)
|
34 |
|
35 | *Know a library that uses Chance that isn't here? Update the README and submit a PR!*
|
36 |
|
37 | ## Author
|
38 | ### Victor Quinn
|
39 | [https://www.victorquinn.com](https://www.victorquinn.com)
|
40 | [@victorquinn](https://twitter.com/victorquinn)
|
41 |
|
42 | Please feel free to reach out to me if you have any questions or suggestions.
|
43 |
|
44 | ### Contributors
|
45 |
|
46 | THANK YOU!
|
47 |
|
48 | ### Contribute!
|
49 |
|
50 | Be a part of this project! You can run the test using the following.
|
51 |
|
52 | **Note: Make sure you have Yarn installed globally**
|
53 |
|
54 | 1. Install dependencies from package.json by running ```yarn```
|
55 | 2. Run the test suite via ```yarn test```
|
56 | 3. Make some fun new modules!
|
57 |
|
58 | This project is licensed under the [MIT License](http://en.wikipedia.org/wiki/MIT_License) so feel free to hack away :)
|
59 |
|
60 | Proudly written in Washington, D.C.
|
61 |
|
62 |
|
\ | No newline at end of file |