Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update getting-started.md to include editing package.json for NPM start #713

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,19 @@ You only need one of those three package managers as a prerequisite, although al
It takes just a few seconds to install Retype using any of the following commands. Choose the command based on a package manager you have installed on your computer.

+++ npm
```
```bash
npm install retypeapp --global
retype start
```
After installation, update your `package.json` to include the following start and build scripts:
```json
"scripts": {
"start": "retype watch",
"build": "retype build"
}
```
Once the scripts are added, you can start the Retype server by running:
```bash
npm start
```
+++ yarn
```
Expand Down Expand Up @@ -232,4 +242,4 @@ OS | Version | Architectures
[Ubuntu-lifecycle]: https://wiki.ubuntu.com/Releases
[Ubuntu-pm]: https://learn.microsoft.com/dotnet/core/install/linux-package-manager-ubuntu-2004
[glibc]: https://www.gnu.org/software/libc/
[musl]: https://musl.libc.org/
[musl]: https://musl.libc.org/