|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| assets/ | H | 15-Jun-2018 | - | | |
| config/ | H | 15-Jun-2018 | - | 8 | 5 |
| guides/ | H | 03-May-2022 | - | 8,890 | 6,389 |
| installer/ | H | 15-Jun-2018 | - | 6,222 | 5,130 |
| lib/ | H | 15-Jun-2018 | - | 14,722 | 11,759 |
| priv/ | H | 15-Jun-2018 | - | 1,339 | 1,051 |
| test/ | H | 15-Jun-2018 | - | 10,250 | 8,350 |
| .babelrc | H A D | 15-Jun-2018 | 26 | 2 | 1 |
| .gitignore | H A D | 15-Jun-2018 | 88 | 11 | 8 |
| .travis.yml | H A D | 15-Jun-2018 | 567 | 29 | 28 |
| CHANGELOG.md | H A D | 15-Jun-2018 | 40.3 KiB | 781 | 600 |
| CODE_OF_CONDUCT.md | H A D | 15-Jun-2018 | 1.9 KiB | 23 | 14 |
| CONTRIBUTING.md | H A D | 15-Jun-2018 | 6.8 KiB | 196 | 145 |
| ISSUE_TEMPLATE.md | H A D | 15-Jun-2018 | 620 | 23 | 8 |
| LICENSE.md | H A D | 15-Jun-2018 | 1 KiB | 23 | 18 |
| README.md | H A D | 15-Jun-2018 | 3 KiB | 79 | 53 |
| RELEASE.md | H A D | 15-Jun-2018 | 1.1 KiB | 23 | 18 |
| mix.exs | H A D | 03-May-2022 | 5 KiB | 191 | 168 |
| mix.lock | H A D | 15-Jun-2018 | 2.1 KiB | 15 | 14 |
| package-lock.json | H A D | 15-Jun-2018 | 261.3 KiB | 6,186 | 6,185 |
| package.json | H A D | 15-Jun-2018 | 1 KiB | 37 | 36 |
README.md
1![phoenix logo](https://raw.githubusercontent.com/phoenixframework/phoenix/master/priv/static/phoenix.png)
2> ### Productive. Reliable. Fast.
3> A productive web framework that does not compromise speed and maintainability.
4
5[![Build Status](https://api.travis-ci.org/phoenixframework/phoenix.svg)](https://travis-ci.org/phoenixframework/phoenix)
6[![Inline docs](http://inch-ci.org/github/phoenixframework/phoenix.svg)](http://inch-ci.org/github/phoenixframework/phoenix)
7
8## Getting started
9
10See the official site at http://www.phoenixframework.org/
11
12## Documentation
13
14API documentation is available at [https://hexdocs.pm/phoenix](https://hexdocs.pm/phoenix)
15
16Phoenix.js documentation is available at [https://hexdocs.pm/phoenix/js](https://hexdocs.pm/phoenix/js)
17
18## Contributing
19
20We 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].
21
22### Generating a Phoenix project from unreleased versions
23
24You can create a new project using the latest Phoenix source installer (the `phx.new` Mix task) with the following steps:
25
261. 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/`.
272. Copy this repo via `git clone https://github.com/phoenixframework/phoenix` or by downloading it
283. Run the `phx.new` mix task from within the `installer` directory, for example:
29
30```bash
31$ cd installer
32$ mix phx.new dev_app --dev
33```
34
35The `--dev` flag will configure your new project's `:phoenix` dep as a relative path dependency, pointing to your local Phoenix checkout:
36
37```elixir
38defp deps do
39 [{:phoenix, path: "../..", override: true},
40```
41
42To 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/master/installer/README.md)
43
44### Building phoenix.js
45
46```bash
47$ npm install
48$ npm run watch
49```
50
51### Building docs from source
52
53```bash
54$ MIX_ENV=docs mix docs
55```
56
57## Important links
58
59* [#elixir-lang][1] on [Freenode][2] IRC
60* [elixir-lang slack channel][3]
61* [Issue tracker][4]
62* [phoenix-talk Mailing list (questions)][5]
63* [phoenix-core Mailing list (development)][6]
64* Visit Phoenix's sponsor, DockYard, for expert [phoenix consulting](https://dockyard.com/phoenix-consulting)
65* Privately disclose security vulnerabilities to phoenix-security@googlegroups.com
66
67 [1]: https://webchat.freenode.net/?channels=#elixir-lang
68 [2]: http://www.freenode.net/
69 [3]: https://elixir-slackin.herokuapp.com/
70 [4]: https://github.com/phoenixframework/phoenix/issues
71 [5]: http://groups.google.com/group/phoenix-talk
72 [6]: http://groups.google.com/group/phoenix-core
73
74## Copyright and License
75
76Copyright (c) 2014, Chris McCord.
77
78Phoenix source code is licensed under the [MIT License](LICENSE.md).
79