phoenixframework/phoenix

Peace of mind from prototype to production.

Getting started

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

Install the latest version of Phoenix by following the instructions at https://phoenix.hexdocs.pm/installation.html#phoenix.

Documentation

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

Phoenix.js documentation is available at https://phoenix.hexdocs.pm/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 phoenix/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 from source

To build the documentation:

MIX_ENV=docs mix docs

To build Phoenix:

mix deps.get
mix compile

To build the Phoenix installer:

mix deps.get
mix compile
mix archive.build

To build Phoenix.js:

mix assets.build

Important links

• #elixir on Libera IRC

• elixir-lang Slack channel

• Issues tracker

• Phoenix Forum (questions and proposals)

• Visit Phoenix's sponsor, DockYard, for expert Phoenix Consulting

Copyright and License

Copyright (c) 2014, Chris McCord.

Phoenix source code is licensed under the MIT License.