Building Wraft

This guide covers building Wraft from source and customizing the platform for your specific needs.

Building from Source

Ensure you have all the prerequisites installed before building Wraft.

Clone the repository
git clone https://github.com/wraft/wraft.git cd wraft
Install dependencies
mix deps.get
Setup the database
mix ecto.setup
Build the application
mix compile
Run tests
mix test

Wraft uses environment variables for configuration. Copy the example environment file and customize it:

cp .env.example .env.dev

Key configuration options include:

To run database migrations:

mix ecto.migrate

To rollback migrations:

mix ecto.rollback

For production builds, compile assets:

mix assets.deploy

Start the development server with an interactive shell:

iex -S mix phx.server

Wraft supports hot reloading during development. Changes to Elixir files will automatically reload the server.

Use the interactive shell for debugging:

# In the IEx shell
iex> Wraft.Repo.all(Wraft.Documents.Document)

For production deployment:

Database connection errors: Ensure PostgreSQL is running and accessible
MinIO connection issues: Verify MinIO server is running on the correct port
Missing dependencies: Run mix deps.get to install all dependencies
Permission errors: Ensure proper file permissions for the application directory