phoenix README

The project's README from github.com/phoenixframework/phoenix. As one markdown file: README.md.

Phoenix logo

Peace of mind from prototype to production.

Build Status Hex.pm Documentation

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

Copyright (c) 2014, Chris McCord.

Phoenix source code is licensed under the MIT License.

phoenix (phoenixframework/phoenix)

Searching Database…

23.2K ·GitHub
Phoenix
What is this?Phoenix is a web framework for Elixir that lets you build productive, reliable, fast applications, from prototype through to production.
Is it a framework or a library?It's a full web framework (like Rails for Elixir), including its own project generator, routing, channels for realtime features, and a JS client library (Phoenix.js).
How do I get a new project running?Install the Phoenix source installer (the phx.new Mix task) following the official instructions, then use it to generate a new Phoenix project.
What language and tooling do I need before using Phoenix?You need Elixir and its Mix build tool installed, since Phoenix projects and the installer are built and managed through Mix.
Do I need to do anything special to use an unreleased version?Yes: you must uninstall any previously installed phx_new archive (via mix archive.uninstall phx_new or by deleting it from ~/.mix/archives/) before Mix will pick up your local source checkout.
What is the --dev flag for when creating a project from source?It configures your new project's :phoenix dependency as a relative path dependency pointing at your local Phoenix checkout, which is useful for testing unreleased changes.
What are similar projects?core, sanic, nitro, sails, socket.io, beego, warp, express
Which topics is it in?api-server, elixir, distributed, realtime, full-stack, web-framework, websocket, backend, framework, npm, api, server
Creator
phoenixframework
Size
25.1 MB
Stars
23.2K
Updated
CommitOct 13Releasev1.8.15Sep 25
Age
12y
Commits · 90 Days