Productive. Reliable. Fast.
A productive web framework that does not compromise speed and maintainability.
Getting started
See the official site at http://www.phoenixframework.org/
Documentation
API documentation is available at https://hexdocs.pm/phoenix
Contributing
We appreciate any contribution to Phoenix. Check our CODE_OF_CONDUCT.md and CONTRIBUTING.md guides for more information. We usually keep a list of features and bugs in the issue tracker.
Generating a Phoenix project from unreleased versions
You can create a new project using the latest Phoenix source installer (the phx.new
Mix task) with the following steps:
- Remove any previously installed
phx_new
archives so that Mix will pick up the local source code. This can be done withmix archive.uninstall phx_new
or by simply deleting the file, which is usually in~/.mix/archives/
. - Copy this repo via
git clone https://github.com/phoenixframework/phoenix
or by downloading it - Run the
phx.new
mix task from within theinstaller
directory, for example:
$ cd installer
$ mix phx.new dev_app --dev
The --dev
flag will configure your new project's :phoenix
dep as a relative path dependency, pointing to your local Phoenix checkout:
defp deps do
[{:phoenix, path: "../..", override: true},
To create projects outside of the installer/
directory, add the latest archive to your machine by following the instructions in installer/README.md
Building phoenix.js
$ npm install
$ npm install -g brunch
$ brunch watch
Building docs from source
$ MIX_ENV=docs mix docs
Important links
- #elixir-lang on Freenode IRC
- elixir-lang slack channel
- Issue tracker
- phoenix-talk Mailing list (questions)
- phoenix-core Mailing list (development)
- Privately disclose security vulnerabilities to phoenix-security@googlegroups.com
Copyright and License
Copyright (c) 2014, Chris McCord.
Phoenix source code is licensed under the MIT License.