Faker is a pure Elixir library for generating fake data.
Clone or download

README.md

Faker

VersionLicenseBuild StatusIssuesDownloadsGitter

Faker is a pure Elixir library for generating fake data.

Quickstart

  • add {:faker, "~> 0.11"} to your deps in mix.exs:

    defp deps do
      [{:faker, "~> 0.11", only: :test}]
    end
  • run:

    mix deps.get
    
  • add Faker.start() to test/test_helper.exs:

    ExUnit.start()
    Faker.start()
  • jump to usage examples.

Requirements

  • OTP 18+
  • Elixir 1.4+

Usage

See documentation and usage examples.

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 project. See the Blacksmith readme for details.

Thanks

Sponsored by Evil Martians

License

Released under the MIT License.