@helpscout/helix/docs/README.md

A Faker-powered fixture generator for Javascript

# Helix

Helix is a [Faker](https://github.com/marak/Faker.js/)-powered fixture generator for Javascript.

Helix allows you to quickly (and reliably) generate fixture data to be hydrated into Javascript components/views (like React, Vue, Backbone, etc…).


## Table of Contents

### Guide
Get Started with Helix

1. [Introduction](./guides)
2. [Creating a spec](./guides/create-spec.md)
3. [Seeding](./guides/seeding.md)
4. [Generating multiple fixtures](./guides/multi-generate.md)
5. [Nesting](./guides/nesting.md)
6. [Composing](./guides/composing.md)
7. [Computed values](./guides/computed.md)


### API
A more in-depth look at Helix's functions and methods

* [HelixSpec](./api/HelixSpec)
* [compose](./api/compose.md)
* [derived](./api/derived.md)
* [faker](./api/faker)
* [oneOf](./api/oneOf.md)