Skip to content

Commit 5e62a39

Browse files
committed
Updates to release notes and up and running
1 parent a2d0c83 commit 5e62a39

File tree

2 files changed

+31
-5
lines changed

2 files changed

+31
-5
lines changed

RELEASE.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release Instructions
22

3-
1. Check related deps for required version bumps and compatibility (`phoenix_ecto`, `phoenix_pubsub_redis`, `phoenix_html`)
3+
1. Check related deps for required version bumps and compatibility (`phoenix_ecto`, `phoenix_html`)
44
2. Bump version in related files below
55
3. Bump external dependency version in related external files below
66
4. Run tests:
@@ -10,7 +10,8 @@
1010
6. Publish `phx_new` and `phoenix` packages and docs after pruning any extraneous uncommitted files
1111
7. Test installer by generating a new app, running `mix deps.get`, and compiling
1212
8. Publish to `npm` with `npm publish`
13-
9. Start -dev version in related files below
13+
9. Update Elixir and Erlang/OTP versions on new.phoenixframework.org
14+
10. Start -dev version in related files below
1415

1516
## Files with version
1617

@@ -21,5 +22,6 @@
2122
* `assets/package.json`
2223

2324
## Files with external dependency versions
25+
2426
* `priv/templates/phx.gen.release/Docker.eex` (debian)
2527
* `priv/templates/phx.gen.release/Docker.eex` (esbuild)

guides/introduction/up_and_running.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,34 @@
11
# Up and Running
22

3-
Let's get a Phoenix application up and running as quickly as possible.
3+
There are two mechanisms to start a new Phoenix application: the express option, supported on some OSes, and via `mix phx.new`. Let's check it out.
44

5-
Before we begin, please take a minute to read the [Installation Guide](installation.html). By installing any necessary dependencies beforehand, we'll be able to get our application up and running smoothly.
5+
## Phoenix Express
66

7-
We can run `mix phx.new` from any directory in order to bootstrap our Phoenix application. Phoenix will accept either an absolute or relative path for the directory of our new project. Assuming that the name of our application is `hello`, let's run the following command:
7+
A single command will get you up and running in seconds:
8+
9+
For macOS/Ubuntu:
10+
11+
```bash
12+
$ curl https://new.phoenixframework.org/myapp | sh
13+
```
14+
15+
For Windows PowerShell:
16+
17+
```cmd
18+
> curl.exe -fsSO https://new.phoenixframework.org/myapp.bat; .\myapp.bat
19+
```
20+
21+
The above will install Erlang, Elixir, and Phoenix, and generate a fresh Phoenix application. It will also automatically pick one of PostgreSQL or MySQL as the database, and fallback to SQLite if none of them are available. Once the command above, it will open up a Phoenix application, with the steps necessary to complete your installation.
22+
23+
> Your Phoenix application name is taken from the path.
24+
25+
If your operating system is not supported, or the command above fails, don't fret! You can still start your Phoenix application using `mix phx.new`.
26+
27+
## Via `mix phx.new`
28+
29+
In order to create a new Phoenix application, you will need to install Erlang, Elixir, and Phoenix. See the [Installation Guide](installation.html) for more information. If you share your application with someone, they will also need to follow the Installation Guide steps to set it all up.
30+
31+
Once you are ready, you can run `mix phx.new` from any directory in order to bootstrap our Phoenix application. Phoenix will accept either an absolute or relative path for the directory of our new project. Assuming that the name of our application is `hello`, let's run the following command:
832

933
```console
1034
$ mix phx.new hello

0 commit comments

Comments
 (0)