Installation
Was this helpful?
Was this helpful?
You will need:
to Petal Pro (or be part of a team with a paid subscription)
this guide is written from the point of view of a Mac. However, it shouldn't be hard to find the equivalents for Linux or Windows
If you just want to see something running without configuring anything:
Download the
Run mix setup
Run mix phx.server
You can now sign in as admin:
Email: admin@example.com
Password: password
Or a normal user:
Email: user@example.com
Password: password
Then you can download:
Done!
If you're a Github member it is possible to clone from the main
branch, but we don't recommend it because there is a higher chance of bugs. Before each release, we do comprehensive testing and ensure the docs are up to date.
If you already have Elixir and Erlang installed you can skip to the next section.
For Macs using Homebrew:
Warning: if you plan to merge in future Petal Pro commits (eg. if you're waiting for an upcoming feature), then perhaps hold off renaming as it makes merging harder.
Your app module is currently called PetalPro
. There is a hex package to help you rename:
This package enables you to use this command:
In your terminal, run the command:
This will fetch dependencies, create and migrate your database, and run the seeds script (creates and admin user and some dummy users).
You can now sign in as admin:
Email: admin@example.com
Password: password
Or a normal user:
Email: user@example.com
Password: password
We have added comments throughout the codebase providing instructions on how to add in your app details and branding. Simply do a global find in your code editor for the text "SETUP_TODO" and follow the instructions.
Database GUI - pick one based on your budget:
Petal Pro is a paid product but we welcome PR's if you find small bugs / typos / improvements. Let us know if you want to contribute in a more significant way and we can offer unlimited membership in return.
We recommend downloading the latest version from a proper "Release" (either from or via a Project).
To download via a project you first need to go to the and create one:
We recommend using to manage your Elixir and Erlang versions. It allows you to have multiple versions on your computer.
In order for tests to work, you will need to install (we utilize for e2e tests). On a Mac you can install it with:
Now you can visit from your browser.
We have some recipes to cover common use cases that aren't part of the normal setup. For example, UUID's instead of ordinary IDs. You can git cherry pick them into your codebase. Check them out .
to replace Mac terminal
to enhance your terminal
to replace BASH with zsh within the terminal
(paid) - though it's included with a subscription
(free)
to help use git
for near instantaneous documentation. Useful when you keep looking up Elixir functions like String.match?
.
for issue tracking
for design
to replace spotlight