Skip to content

Commit

Permalink
quickstarts grammar/spelling/clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
blimmer authored and floodfx committed Oct 18, 2022
1 parent 992ddda commit c2cf87d
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ browser.

## Setup a new Route

Let's add a route to this LiveView so we can see it in our browser. Edit `packages/deno/src/example/index.ts` and make
Let's add a route to this LiveView to see it in our browser. Edit `packages/deno/src/example/index.ts` and make
the following highlighted changes:

```ts title="packages/deno/src/example/index.ts" {3,7}
Expand Down Expand Up @@ -94,5 +94,5 @@ should look something like this:
## Great start!
You've just created your first LiveView and added it to your webserver! There is a lot more to learn about
**LiveViewJS** but you are well on your way. We recommend you continue to the
**LiveViewJS**, but you are well on your way. We recommend you continue to the
[Anatomy of a LiveView](/docs/category/anatomy-of-a-liveview) section to start to learn more about how LiveViews work.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ contains all the examples and configured webserver code for Express (NodeJS) and

Either use `git clone` or `degit` to get the **LiveViewJS** GitHub repository.

:::info `degit` is lightweight way to clone a repo without the .git parts.
:::info `degit` is a lightweight way to clone a repo without the .git parts.
[More info](https://github.com/Rich-Harris/degit). :::

### Clone the **LiveViewJS** GitHub repository:
Expand All @@ -37,11 +37,11 @@ cd liveviewjs

## Node or Deno?

**LiveViewJS** runs on both Node and Deno but you'll probably want to start down one path or the other depending on what
**LiveViewJS** runs on both Node and Deno, but you'll probably want to start down one path or the other depending on what
runtime you are more familiar with or are already using.

:::note The **LiveViewJS** library APIs are the same so you can build your LiveViews on one platform and run them on the
other unless you are using Deno or Node specific APIs in your LiveView implementation. :::
other unless you are using Deno or Node-specific APIs in your LiveView implementation. :::

### Node

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ browser.

## Setup a new Route

Let's add a route to this LiveView so we can see it in our browser. Edit `packages/express/src/example/index.ts` and
Let's add a route to this LiveView to see it in our browser. Edit `packages/express/src/example/index.ts` and
make the following highlighted changes:

```ts title="packages/express/src/example/index.ts" {3,7}
Expand Down Expand Up @@ -67,16 +67,16 @@ ExperimentalWarning: The Fetch API is an experimental feature. This feature coul
(Use `node --trace-warnings ...` to show where the warning was created)
```
The feature we are using is the built in `fetch` method. Feel free to ignore this warning. :::
The feature we are using is the built-in `fetch` method. Feel free to ignore this warning. :::
## See the LiveView in Action
Point your browser to [http://localhost:4001/hello](http://localhost:4001/hello) and you should see something like the
Point your browser to [http://localhost:4001/hello](http://localhost:4001/hello), and you should see something like the
following: ![LiveViewJS Hello World Screenshot](/img/screenshots/liveviewjs_hello_liveview.png)
## Next Steps
Ok we got our first LiveView running but it isn't very interactive. Let's make it more interesting by adding a button
Ok, we got our first LiveView running but it isn't very interactive. Let's make it more interesting by adding a button
that toggles between using text and emojis to say hello. Update the `hello.ts` file to the following:
```ts title="packages/express/src/example/liveview/hello.ts"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ to get a feel for the user experience of a LiveView. Let's get started!

[Node.js](https://nodejs.org/en/download/) version 18.x or above.

:::note We rely on the NodeJS Fetch API which is only available in 18+. :::
:::note We rely on the NodeJS Fetch API, which is only available in 18+. :::

If you haven't already, [download the **LiveViewJS** repo](get-liveviewjs-repo).

Expand Down

0 comments on commit c2cf87d

Please sign in to comment.