PhoenixBase is maintained by Infinite Red, a web and mobile development company based in Portland, OR and San Francisco, CA.
To start your Phoenix app:
bin/setup
mix phoenix.server
Now you can visit localhost:4000
from your browser.
Ready to run in production? Please check our deployment guides.
Setting up a CI server such as Semaphore is easy with the included scripts. Set up your build to run the setup command. (It also runs bin/ci
)
MIX_ENV=test bin/setup
You can also use bin/ci
to run the tests locally to ensure everything will pass on your CI build.
Since it is likely you'll want to change the name of this project after you've cloned it, we've included a script to make it easy for you:
bin/rename_project PhoenixBase phoenix_base CoolProject cool_project
Note: this command relies on sed
. It has been tested on recent Mac versions of sed
(macOS 10.11+) and GNU sed. If you're on a Mac and need to upgrade, try brew install gnu-sed
and follow the instructions to update your $PATH.
PhoenixBase comes with a basic Bitters setup for front end HTML/CSS and grid. You can learn more about it at the links below, but here is an intro.
Note that the Bitters files (web/static/css/base/*.scss) are autogenerated and should be left alone.
Layouts are used for structuring and laying out your pages and making them respond to mobile responsive styles. Look at web/static/css/layouts/_home.sass for an example.
Components are for detailed styling of various page components.
PhoenixBase, as an source project, is free to use and always will be. Infinite Red offers premium PhoenixBase support and general mobile app design/development services. Email us at hello@infinite.red to get in touch with us for more details.
See the LICENSE file for license rights and limitations (MIT).