mirrors/phoenix
1
0
Fork 0
mirror of https://github.com/phoenixframework/phoenix.git synced 2026-01-11 13:29:00 -03:00
Code Issues Projects Releases Packages Wiki Activity
Peace of mind from prototype to production https://www.phoenixframework.org
8,705 commits 33 branches 160 tags 38 MiB
Find a file
Exact
siiky 3ce8623f26
 Starting guides fixes (#6567) 
* Small fixes to the "Components and HEEx" guide

* Fix "Swapping Databases" link

"Using other databases" was moved to "Swapping Databases" in
8da97b3749.
2026-01-09 15:19:14 +01:00
.github Bump actions/setup-node from 6.0.0 to 6.1.0 (#6568) 2026-01-01 15:59:47 +01:00
assets Stop reconnecting when page is hidden (#6534) 2025-11-19 19:15:47 +01:00
config sort query params in verified routes during tests (#6536) 2025-12-02 12:26:32 +01:00
guides Starting guides fixes (#6567) 2026-01-09 15:19:14 +01:00
installer Release 1.8.3 2025-12-08 14:28:54 -05:00
integration_test update dependencies (#6482) 2025-09-23 10:53:47 +02:00
lib Add URI decoding for route segments and test unicode path handling (#6559) 2025-12-11 12:02:42 +01:00
priv Remove autocomplete attribute from hidden field (#6573) 2026-01-09 14:22:06 +01:00
test Add URI decoding for route segments and test unicode path handling (#6559) 2025-12-11 12:02:42 +01:00
usage-rules Fix missing closing bold tag in html.md (#6546) 2025-12-08 14:15:11 +01:00
.formatter.exs add refute_patched to locals_without_parens (#6374) 2025-08-03 20:33:40 +02:00
.gitignore invert copy_core_component (#6155) 2025-04-03 18:05:34 +02:00
babel.config.json use single package.json (#6044) 2025-01-11 16:48:13 +01:00
CHANGELOG.md Release 1.8.3 2025-12-08 14:28:54 -05:00
CODE_OF_CONDUCT.md Replace http with https whenever possible (#4577) 2021-11-02 11:22:06 -07:00
CONTRIBUTING.md docs: minor grammar etc improvements. (#5879) 2024-07-25 21:57:29 +01:00
eslint.config.mjs Update Node Deps (#6283) 2025-06-03 13:09:49 +02:00
jest.config.js no need for global jsdom (#6303) 2025-06-13 15:53:13 +02:00
LICENSE.md Explicity mention MIT License in the README.md and convert License to markdown [ci skip] 2015-10-03 18:23:21 -04:00
logo.png Align Phoenix logo 2020-01-30 15:59:53 +01:00
mix.exs Release 1.8.3 2025-12-08 14:28:54 -05:00
mix.lock Release 1.8.3 2025-12-08 14:28:54 -05:00
package-lock.json Bump the minor-and-patch group with 4 updates (#6572) 2026-01-01 15:58:41 +01:00
package.json Bump the minor-and-patch group with 4 updates (#6572) 2026-01-01 15:58:41 +01:00
README.md Update contrib guide on how to generate docs (#6452) 2025-09-01 11:00:04 +02:00
RELEASE.md Updates to release notes and up and running 2024-12-04 13:44:04 +01:00
SECURITY.md Update SECURITY.md 2023-10-09 16:16:47 +01:00

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://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 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:

npm install
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:

cd assets
npm install

Important links

Copyright and License

Copyright (c) 2014, Chris McCord.

Phoenix source code is licensed under the MIT License.