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
Что это такое?Phoenix — это веб-фреймворк для Elixir, который помогает быстро и надёжно создавать приложения: от прототипа до готового продукта.
Это фреймворк или библиотека?Это полноценный веб-фреймворк (что-то вроде Rails для Elixir). В него входят собственный генератор проектов, маршрутизация, каналы для функций реального времени и JS-клиентская библиотека (Phoenix.js).
Как запустить новый проект?Установите исходный установщик Phoenix (Mix-задачу phx.new), следуя официальной инструкции, а затем с его помощью создайте новый проект 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
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