Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phoenixframework/phoenix
Peace of mind from prototype to production
https://github.com/phoenixframework/phoenix
api-server distributed elixir realtime web-framework
Last synced: 5 days ago
JSON representation
Peace of mind from prototype to production
- Host: GitHub
- URL: https://github.com/phoenixframework/phoenix
- Owner: phoenixframework
- License: mit
- Created: 2014-01-20T14:14:11.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2025-01-05T21:07:34.000Z (20 days ago)
- Last Synced: 2025-01-11T07:05:59.978Z (15 days ago)
- Topics: api-server, distributed, elixir, realtime, web-framework
- Language: Elixir
- Homepage: https://www.phoenixframework.org
- Size: 19.9 MB
- Stars: 21,616
- Watchers: 559
- Forks: 2,892
- Open Issues: 76
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome - phoenixframework/phoenix - Peace of mind from prototype to production (Elixir)
- Awesome - Phoenix framework - [www.phoenixframework.org](https://www.phoenixframework.org) (Development / Programming)
- fucking-awesome-elixir - phoenix - Elixir Web Framework targeting full-featured, fault tolerant applications with realtime functionality. (Frameworks)
- awesome-repositories - phoenixframework/phoenix - Peace of mind from prototype to production (Elixir)
- awesome-starred - phoenixframework/phoenix - Peace of mind from prototype to production (elixir)
- StarryDivineSky - phoenixframework/phoenix
- awesome-elixir - phoenix - Elixir Web Framework targeting full-featured, fault tolerant applications with realtime functionality. (Frameworks)
- freaking_awesome_elixir - Elixir - Elixir Web Framework targeting full-featured, fault tolerant applications with realtime functionality. (Top 20 packages)
README
> Peace of mind from prototype to production.
[](https://github.com/phoenixframework/phoenix/actions/workflows/ci.yml) [](https://hex.pm/packages/phoenix) [](https://hexdocs.pm/phoenix)
## Getting started
See the official site at .
Install the latest version of Phoenix by following the instructions at .
## Documentation
API documentation is available at .
Phoenix.js documentation is available at .
## Contributing
We appreciate any contribution to Phoenix. Check our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) and [CONTRIBUTING.md](CONTRIBUTING.md) guides for more information. We usually keep a list of features and bugs in the [issue tracker][4].
### 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:
```bash
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:
```elixir
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](https://github.com/phoenixframework/phoenix/blob/main/installer/README.md)
### Building from source
To build the documentation:
```bash
npm install --prefix assets
MIX_ENV=docs mix docs
```
To build Phoenix:
```bash
mix deps.get
mix compile
```
To build the Phoenix installer:
```bash
mix deps.get
mix compile
mix archive.build
```
To build Phoenix.js:
```bash
cd assets
npm install
```
## Important links
* [#elixir][1] on [Libera][2] IRC
* [elixir-lang Slack channel][3]
* [Issues tracker][4]
* [Phoenix Forum (questions and proposals)][5]
* Visit Phoenix's sponsor, DockYard, for expert [Phoenix Consulting](https://dockyard.com/phoenix-consulting)
[1]: https://web.libera.chat/?channels=#elixir
[2]: https://libera.chat/
[3]: https://elixir-lang.slack.com/
[4]: https://github.com/phoenixframework/phoenix/issues
[5]: https://elixirforum.com/c/phoenix-forum
## Copyright and License
Copyright (c) 2014, Chris McCord.
Phoenix source code is licensed under the [MIT License](LICENSE.md).