GitHub - phoenixframework/phoenix: Productive. Reliable. Fast.

Productive. Reliable. Fast.

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

Getting started

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

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

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

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.

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 with mix 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 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

To build the documentation from source:

$ cd assets
$ npm install
$ cd ..
$ MIX_ENV=docs mix docs

To build Phoenix from source:

$ mix deps.get
$ mix compile

To build the Phoenix installer from source:

$ mix deps.get
$ mix compile
$ mix archive.build

$ cd assets
$ npm install
$ npm run watch

Phoenix source code is licensed under the MIT License.

Name	Latest commit message	Commit time
Failed to load latest commit information.
assets	Switch to https for phoenixframework.org website (#3599 )	Nov 1, 2019
config	Add public Phoenix.json_library	Feb 9, 2018
guides	Move container guides to their own section, closes #3624	Dec 12, 2019
installer	Updated `channel_case` sandbox documentation (#3634 )	Dec 12, 2019
lib	Raise semantic error on bad URI decoding	Dec 20, 2019
priv	Fix inconsistency in generated docs (#3617 )	Dec 12, 2019
test	Raise semantic error on bad URI decoding	Dec 20, 2019
.formatter.exs	Add LiveView formatter rules	Mar 29, 2019
.gitignore	Copy assets for hex installer	Sep 22, 2018
.travis.yml	Also test on latest Elixir	Sep 6, 2019
CHANGELOG.md	Deprecate :pubsub key	Jun 28, 2019
CODE_OF_CONDUCT.md	Add Code of Conduct	Sep 14, 2015
CONTRIBUTING.md	Fix `ConnTest` and `Contributing` typos (#3613 )	Nov 15, 2019
ISSUE_TEMPLATE.md	Update ISSUE_TEMPLATE.md	Jun 22, 2019
LICENSE.md	Explicity mention MIT License in the README.md and convert License to…	Oct 3, 2015
README.md	Switch to https for phoenixframework.org website (#3599 )	Nov 1, 2019
RELEASE.md	Update to latest Elixir on the installer	Oct 31, 2019
logo.png	Use same logo as phoenix does in its docs	Dec 18, 2016
mix-cowboy1.lock	Prepare for Plug v1.7 and default to Cowboy 2 (#3107 )	Oct 20, 2018
mix.exs	Add parens to static remote nullary calls	Nov 8, 2019
mix.lock	Update to latest Phoenix LiveView instructions	Nov 19, 2019
package.json	Switch to https for phoenixframework.org website (#3599 )	Nov 1, 2019