Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elixirs/faker

Faker is a pure Elixir library for generating fake data.
https://github.com/elixirs/faker

data data-generator database developer-tools dummy elixir fake-content faker generator hacktoberfest phoenix qa seed seeding test testing testing-tools

Last synced: 10 days ago
JSON representation

Faker is a pure Elixir library for generating fake data.

Host: GitHub
URL: https://github.com/elixirs/faker
Owner: elixirs
License: mit
Created: 2014-04-08T20:05:26.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-10-08T18:38:43.000Z (about 1 month ago)
Last Synced: 2024-10-18T14:05:35.406Z (21 days ago)
Topics: data, data-generator, database, developer-tools, dummy, elixir, fake-content, faker, generator, hacktoberfest, phoenix, qa, seed, seeding, test, testing, testing-tools
Language: Elixir
Homepage:
Size: 1.15 MB
Stars: 1,075
Watchers: 17
Forks: 218
Open Issues: 53
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

freaking_awesome_elixir - Elixir - Faker is a pure Elixir library for generating fake data. (Testing)

README

        # Faker

[![build](https://github.com/elixirs/faker/actions/workflows/ci.yaml/badge.svg)](https://github.com/elixirs/faker/actions/workflows/ci.yaml)

[![Version](https://img.shields.io/hexpm/v/faker.svg?style=flat-square)](https://hex.pm/packages/faker)

[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/faker/)

[![License](https://img.shields.io/hexpm/l/faker.svg?style=flat-square)](https://github.com/elixirs/faker/blob/master/LICENSE)

[![Issues](https://img.shields.io/github/issues/elixirs/faker.svg?style=flat-square)](https://github.com/elixirs/faker/issues)

[![Downloads](https://img.shields.io/hexpm/dt/faker.svg?style=flat-square)](https://hex.pm/packages/faker)

[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/igas/faker)

[![Last Updated](https://img.shields.io/github/last-commit/elixirs/faker.svg)](https://github.com/elixirs/faker/commits/master)

**Faker** is a pure [Elixir](http://elixir-lang.org/) library for generating

fake data.

- [Faker](#faker)

  - [Quickstart](#quickstart)

  - [Requirements](#requirements)

  - [Usage](#usage)

  - [Troubleshooting](#troubleshooting)

  - [Tools](#tools)

  - [Templating](#contributing)

  - [Team](#team)

  - [Contributing](#contributing)

  - [Thanks](#thanks)

  - [License](#license)

## Quickstart

* add `{:faker, "~> 0.18"}` to your deps in `mix.exs`:

    ```elixir

    defp deps do

      [

        {:faker, "~> 0.18", only: :test}

      ]

    end

    ```

* run:

    ```

    mix deps.get

    ```

* add `Faker.start()` to `test/test_helper.exs`:

    ```elixir

    ExUnit.start()

    Faker.start()

    ```

* jump to [usage examples](#usage).

### Requirements

* OTP 19+

* Elixir 1.6+

## Usage

See [documentation](http://hexdocs.pm/faker/) and [usage examples](https://github.com/elixirs/faker/blob/master/USAGE.md).

## Troubleshooting

* If you get a message like the one below when you call `Faker.Address.city/0`,

you need to add `:faker` to your application's mix file, in the `applications`

function, as above.

    ```

    ** (FunctionClauseError) no function clause matching in Faker.Address.city_count/1

    lib/faker/address.ex:48: Faker.Address.city_count(nil)

    lib/faker/address.ex:41: Faker.Address.city/0

    ```

## Tools

Faker was designed as a lightweight library, that's why it can be easily used

with other tools.

## Templating

You can build templates for testing purposes with the

[Blacksmith](https://github.com/batate/blacksmith) project. See the Blacksmith

[readme](https://github.com/batate/blacksmith#readme) for details.

## Team

Faker was originally written by [Igor Kapkov](https://igas.me).

Current list of maintainers:

* [Anthony Smith](https://github.com/anthonator)

* [Igor Kapkov](https://igas.me)

* [Toby Hinloopen](https://github.com/tobyhinloopen)

* [Vitor Oliveira](https://github.com/vbrazo)

## Contributing

Do you want to become a maintainer?

See our [CONTRIBUTING.md](https://github.com/elixirs/faker/blob/master/CONTRIBUTING.md) and start contributing today. We usually elect new maintainers based on contributions.

## Thanks

[![Sponsored by Evil Martians](https://evilmartians.com/badges/sponsored-by-evil-martians.svg)](https://evilmartians.com/)

## [License](https://github.com/elixirs/faker/blob/master/LICENSE)

Released under the MIT License.