Skip to content
Productive. Reliable. Fast.
Branch: master
Clone or download
Pull request Compare This branch is 7 commits ahead, 788 commits behind phoenixframework:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Gracefully fallback to window Sep 22, 2017
config
guides
installer
lib
priv
test
.babelrc
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
ISSUE_TEMPLATE.md
LICENSE.md
README.md
RELEASE.md
brunch-config.js
logo.png
mix.exs
mix.lock
package-lock.json
package.json

README.md

phoenix logo

Productive. Reliable. Fast.

A productive web framework that does not compromise speed and maintainability.

Build Status Inline docs

Getting started

See the official site at http://www.phoenixframework.org/

Documentation

API documentation is available at https://hexdocs.pm/phoenix

Phoenix.js documentation is available at https://hexdocs.pm/phoenix/js

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:

  1. Remove any previously installed phx_new archives so that Mix will pick up the local source code. This can be done with mix archive.uninstall phx_new or by simply deleting the file, which is usually in ~/.mix/archives/.
  2. Copy this repo via git clone https://github.com/phoenixframework/phoenix or by downloading it
  3. Run the phx.new mix task from within the installer 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 run watch

Building docs from source

$ MIX_ENV=docs mix docs

Important links

Copyright and License

Copyright (c) 2014, Chris McCord.

Phoenix source code is licensed under the MIT License.

You can’t perform that action at this time.