Installation
Last updated
Was this helpful?
Last updated
Was this helpful?
If you just want to see something running without configuring anything:
Download the
Run mix setup
Run mix phx.server
We recommend downloading the latest version from a "Release" (either from or our ).
It is possible to clone from the main
branch - there is a slightly higher chance of bugs (although we will endeavour to keep the main
branch as stable as possible).
If you already have Elixir and Erlang installed you can skip to the next section.
We recommend using to manage your Elixir and Erlang versions. It allows you to have multiple versions on your computer.
For Macs using Homebrew:
Warning: if you plan to merge in future Petal Pro commits (eg. if you're waiting for an upcoming feature like payment handling), then perhaps hold off renaming as it makes merging harder.
Your app module is currently called PetalPro
. There is a script file included that will rename your project to anything you like in one go. Open the file rename_phoenix_project.sh
and read the instructions at the top.
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).
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.
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.
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