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 是一个用于 Elixir 的 Web 框架,可以帮助你从原型到生产环境,高效、可靠、快速地构建应用。
它是框架还是库?它是一个完整的 Web 框架(类似于 Elixir 里的 Rails),包括自带的项目生成器、路由、用于实时功能的 Channels,以及一个 JS 客户端库(Phoenix.js)。
怎样才能运行一个新项目?按照官方说明安装 Phoenix 源码安装器(phx.new Mix 任务),然后用它生成一个新的 Phoenix 项目。
使用 Phoenix 之前需要什么语言和工具?你需要先安装 Elixir 及其 Mix 构建工具,因为 Phoenix 项目和安装器都是通过 Mix 构建和管理的。
要使用未发布的版本,需要做什么特别的操作吗?需要:在 Mix 能够识别你的本地源码检出之前,你必须先卸载之前安装的 phx_new 归档(可以运行 mix archive.uninstall phx_new,或直接从 ~/.mix/archives/ 中删除它)。
从源码创建项目时,--dev 参数有什么作用?它会把新项目的 :phoenix 依赖配置为指向你本地 Phoenix 检出目录的相对路径依赖,便于测试尚未发布的改动。
What are similar projects?core, sanic, nitro, sails, socket.io, beego, warp, express
Size
25.1 MB
Stars
23.2K
Age
12y
Commits · 90 Days