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 http://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.
Running a Phoenix master project
$ cd installer
$ mix phoenix.new path/to/your/project --dev
The command above will create a new project using your current Phoenix checkout, thanks to the --dev
flag.
Note that path/to/your/project
must be within the directory containing the Phoenix source code. This is so that a relative path can be used for the :phoenix
dependency.
The command must be run from the installer
directory. See the discussion in PR 1224 for more information.
In order to test changes to the installer (the phoenix.new
Mix task) itself, first remove any installed archive so that Mix will pick up the local source code. This can be done with mix archive.uninstall phoenix_new-#.#.#.ez
or by simply deleting the file, which is usually in ~/.mix/archives/
. See issue 3376 for more information.
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 [email protected]
Copyright and License
Copyright (c) 2014, Chris McCord.
Phoenix source code is licensed under the MIT License.