Github url

phoenix

by phoenixframework

phoenixframework /phoenix

Peace-of-mind from prototype to production

15.4K Stars 2.0K Forks Last release: 15 days ago (v1.5.3) MIT License 6.5K Commits 93 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

phoenix logo

Productive. Reliable. Fast.

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

Build StatusInline docs

Getting started

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

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

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

To build the documentation from source:

$ npm install --prefix assets $ 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

Building phoenix.js

$ cd assets $ npm install $ npm run watch

Important links

Copyright and License

Copyright (c) 2014, Chris McCord.

Phoenix source code is licensed under the MIT License.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.