0.0.1 โ€ข Published 5 years ago

example-data v0.0.1

Weekly downloads
4
License
MIT
Repository
-
Last release
5 years ago

๐Ÿฆ• example-data

npm version downloads coverage pipeline

Demo | Video Tutorial

example-data is a javascript library for generating json-formatted data that relates to examples of commonly used data in application development. Examples of commonly used application data includes users, videos, images, games, web applications, community forums, chat channels, blogs posts, and news articles.

This project is a work-in-progress and does not completely work as suggested by this document. Parts of the system work as suggested, other parts are still being worked on.

Keywords

Example data, mocking library, offline, test data, realistic data, dummy data, fake data

About

JSON

Benefits

Features

  • ๐Ÿ“ก Offline: Continue app development, even without an internet connection

Limitations

  • ๐Ÿงช Experimental: This project is a work-in-progress

Additional Notes

Progress Report

See the to-do list for a progress report on remaining tasks.

Browser Compatibility

example-data supports all browsers that are ES5-compliant (IE8 and below are not supported).

Screenshots

Explore the public demo or visit the test/visual directory to run the visualizer locally.

Installation

Install the library

npm install example-data --save

Import the library

import * as exampleData from 'example-data'

Or import the browser script

<script src="https://unpkg.com/example-data@latest/dist/library.js"></script>

Example Usecases

For working demos that use this library, please visit the examples directory.

API Reference

Documentation

To check out project-related documentation, please visit docs. See metrics for performance-related documentation.

Contributing

Everyone can contribute. All are welcome. Please see contributing guide.

Acknowledgements

Software Dependencies

Tooling
TypeScript

Learn More

๐ŸŽฌ Watch a video on how to use the visualizer ๐ŸŽฌ Watch a video on how to use this library ๐ŸŽฌ Watch a video on how this library is made

Related Work

Some well-known tools for generating example data include: JSON Generator, Mockaroo, json-data-generator, WireMock example-data

License

MIT