Getting Started
View SourceNeoFaker is an Elixir library that generates fake data for testing and development.
Requirements
NeoFaker requires Erlang 27.0
and Elixir 1.18.0-otp-27
or later.
Installation
Add NeoFaker to your dependencies in mix.exs
:
def deps do
[
{:neo_faker, "~> 0.10.0", only: [:dev, :test]}
]
end
Then, fetch the dependencies:
mix deps.get
Configuration
Set the default locale in config.exs
:
config :neo_faker, locale: :default
Setting Configuration in Phoenix
In Phoenix Framework, set the locale in config/dev.exs
or
config/test.exs
.
Then add NeoFaker.start()
to test/test_helper.exs
:
ExUnit.start()
NeoFaker.start() # Add this line
If the specified locale is unavailable, it will fall back to :default
.
You can find the list of available locales on the Available Locales page.
Usage
Generate fake data using NeoFaker:
iex> NeoFaker.App.name()
"Neo Faker"
iex> NeoFaker.App.description()
"An Elixir library for generating fake data in tests and development."
iex> NeoFaker.App.description(locale: :id_id)
"Pustaka Elixir untuk menghasilkan data palsu dalam pengujian dan pengembangan."
For complete documentation, visit the API Reference. For a quick overview, check out the Cheat Sheet.
License
NeoFaker is licensed under the MIT License.