{"__v":7,"_id":"54fdb1839f864e2300f6fc2a","category":{"__v":1,"_id":"54fdb1829f864e2300f6fc1f","pages":["54fdb1839f864e2300f6fc2a","54fdb1839f864e2300f6fc2b","54fdb1839f864e2300f6fc2c","54fdb1839f864e2300f6fc2d"],"project":"54348ec95b10711400c6c445","version":"54fdb1829f864e2300f6fc1e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-08T01:09:29.386Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"project":"54348ec95b10711400c6c445","user":"54348e770ef9c008001651d4","version":{"__v":1,"_id":"54fdb1829f864e2300f6fc1e","forked_from":"54e51b71d71c112d0054410f","project":"54348ec95b10711400c6c445","createdAt":"2015-03-09T14:43:14.144Z","releaseDate":"2015-03-09T14:43:14.144Z","categories":["54fdb1829f864e2300f6fc1f","54fdb1829f864e2300f6fc20","54fdb1829f864e2300f6fc21"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":false,"codename":"","version_clean":"0.10.0","version":"0.10.0"},"updates":["54908ea60c7786160022fb05","549c8227ff61301f00a6c69e","549c8cd8ff61301f00a6c6a6","549c9365ff61301f00a6c6a8","54b185de216cfa1400f219f6","54b2c5ed336cfb0b00608c24","54e0f67bebbf8f0d00b3b8e3","55013f673d49a23700d5e448","551c959c7405910d00900a4f","566a2b72b5ccc20d00817e76"],"next":{"pages":[],"description":""},"createdAt":"2014-10-08T01:09:29.419Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"never","params":[],"url":""},"isReference":false,"order":0,"body":"## Requirements\n\n- Elixir v1.0.2+\n\n[Install Elixir](http://elixir-lang.org/install.html)\n\n    git clone https://github.com/phoenixframework/phoenix.git && cd phoenix && git checkout v0.10.0 && mix do deps.get, compile\n\nCreate a new Phoenix application with front end tools included\n\n    mix phoenix.new /path/to/scaffold/my_app\n    \nOr create a new Phoenix application without front end tools\n\n    mix phoenix.new /path/to/scaffold/my_app --no-brunch\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Important\",\n  \"body\": \"Run this task in the Phoenix installation directory cloned in the step above. The path provided: `/path/to/scaffold/my_app/` should be outside of the framework installation directory. This will either create a new application directory or install the application into an existing directory.\\n\\n#### Examples:\\n    mix phoenix.new /Users/you/projects/my_app\\n    mix phoenix.new ../relative_path/my_app\"\n}\n[/block]\nThe phoenix.new task will prompt you to install dependencies and prompt you on how to start the new application. Say yes to the prompts. When the dependencies are loaded, cd into the new application directory, and run:\n    mix phoenix.server\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note\",\n  \"body\": \"On some Linux systems, Erlang installations do not include the Erlang ssl or inets packages. This will cause hex to fail. If you see a message like this.\\n\\n```console\\n$  mix do deps.get, compile\\nCould not start Hex. Try fetching a new version with `mix local.hex` or uninstalling it with `mix archive.uninstall hex.ez`\\n** (UndefinedFunctionError) undefined function: :ssl.start/0 (module :ssl is not available)\\n. . . \\n```\\nTry installing those packages manually. Of course, substitute the package manager for your system if it doesn't use apt as the example does.\\n\\n```console\\n$ sudo apt-get install erlang-ssl\\n$ sudo apt-get install erlang-inets\\n```\"\n}\n[/block]\nBy default Phoenix accepts requests on port 4000. If we point our favorite web browser at [http://localhost:4000](http://localhost:4000), we should see the Phoenix Framework welcome page.\n\n## What next? \n\nCheck out some of the other guides in the sidebar or view the official [docs](http://hexdocs.pm/phoenix).","excerpt":"This page will help you get started with Phoenix. You'll be up and running in a jiffy!","slug":"getting-started","type":"basic","title":"Getting Started with Phoenix"}

Getting Started with Phoenix

This page will help you get started with Phoenix. You'll be up and running in a jiffy!

## Requirements - Elixir v1.0.2+ [Install Elixir](http://elixir-lang.org/install.html) git clone https://github.com/phoenixframework/phoenix.git && cd phoenix && git checkout v0.10.0 && mix do deps.get, compile Create a new Phoenix application with front end tools included mix phoenix.new /path/to/scaffold/my_app Or create a new Phoenix application without front end tools mix phoenix.new /path/to/scaffold/my_app --no-brunch [block:callout] { "type": "info", "title": "Important", "body": "Run this task in the Phoenix installation directory cloned in the step above. The path provided: `/path/to/scaffold/my_app/` should be outside of the framework installation directory. This will either create a new application directory or install the application into an existing directory.\n\n#### Examples:\n mix phoenix.new /Users/you/projects/my_app\n mix phoenix.new ../relative_path/my_app" } [/block] The phoenix.new task will prompt you to install dependencies and prompt you on how to start the new application. Say yes to the prompts. When the dependencies are loaded, cd into the new application directory, and run: mix phoenix.server [block:callout] { "type": "info", "title": "Note", "body": "On some Linux systems, Erlang installations do not include the Erlang ssl or inets packages. This will cause hex to fail. If you see a message like this.\n\n```console\n$ mix do deps.get, compile\nCould not start Hex. Try fetching a new version with `mix local.hex` or uninstalling it with `mix archive.uninstall hex.ez`\n** (UndefinedFunctionError) undefined function: :ssl.start/0 (module :ssl is not available)\n. . . \n```\nTry installing those packages manually. Of course, substitute the package manager for your system if it doesn't use apt as the example does.\n\n```console\n$ sudo apt-get install erlang-ssl\n$ sudo apt-get install erlang-inets\n```" } [/block] By default Phoenix accepts requests on port 4000. If we point our favorite web browser at [http://localhost:4000](http://localhost:4000), we should see the Phoenix Framework welcome page. ## What next? Check out some of the other guides in the sidebar or view the official [docs](http://hexdocs.pm/phoenix).