Building Wraft
Building and customizing Wraft
Building Wraft
This guide covers building Wraft from source and customizing the platform for your specific needs.
Building from Source
Prerequisites
Ensure you have all the prerequisites installed before building Wraft.
Build Process
-
Clone the repository
-
Install dependencies
-
Setup the database
-
Build the application
-
Run tests
Customization
Environment Configuration
Wraft uses environment variables for configuration. Copy the example environment file and customize it:
Key configuration options include:
- Database connection settings
- MinIO/S3 storage configuration
- Application secrets and keys
- External service integrations
Database Migrations
To run database migrations:
To rollback migrations:
Asset Compilation
For production builds, compile assets:
Development Workflow
Interactive Development
Start the development server with an interactive shell:
Hot Reloading
Wraft supports hot reloading during development. Changes to Elixir files will automatically reload the server.
Debugging
Use the interactive shell for debugging:
Production Build
For production deployment:
-
Set production environment
-
Install production dependencies
-
Compile for production
-
Run database migrations
-
Start the production server
Troubleshooting
Common Issues
- 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
Getting Help
- Check the GitHub Issues for known problems
- Review the API Documentation for endpoint details
- Join the community discussions for support