Skip to content

Commit

Permalink
added steps formatting (#325)
Browse files Browse the repository at this point in the history
  • Loading branch information
03cranec authored Feb 5, 2024
1 parent fc371f7 commit a5e7102
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
13 changes: 9 additions & 4 deletions apps/framework-docs/src/pages/getting-started/dev-mode.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Callout } from 'nextra/components'
import { Callout, Steps } from 'nextra/components'

# What is Developer Mode
One of Moose's most powerful features is "Dev" mode. When you run your Moose application in developer mode, the Moose CLI will spin up a local version of your entire Moose app. It will then watch your project folder for any code changes, and automatically update your locally running app as you save changes. This let's you validate the impact of your code changes in real time as you develop
Expand All @@ -11,21 +11,26 @@ One of Moose's most powerful features is "Dev" mode. When you run your Moose app

There are a couple different ways you can utilize the Moose CLI. First go to your project directory `cd my-app`.

1. The simplest method to run the CLI is via NPX. No extra installation is necessary for this method.
<Steps>
### NPX
The simplest method to run the CLI is via NPX. No extra installation is necessary for this method.
```txt filename="Terminal" copy
npx @514labs/moose-cli dev
```

2. Alternatively, the Moose CLI comes packaged with your Moose application. You can install the dependency locally and then run the Moose CLI within your project with:
### Dependency install
Alternatively, the Moose CLI comes packaged with your Moose application. You can install the dependency locally and then run the Moose CLI within your project with:
```txt filename="Terminal" copy
npm install
npm run dev
```

3. Finally, you can install the Moose CLI globally using NPM. This will get you a cleaner command interface, and better performance on the CLI. You can then run the Moose CLI anywhere.
### Global install
Finally, you can install the Moose CLI globally using NPM. This will get you a cleaner command interface, and better performance on the CLI. You can then run the Moose CLI anywhere.
```txt filename="Terminal" copy
npm install -g @514labs/moose-cli
moose dev
```
</Steps>

Now that you're up and running in Dev mode, you can visit [http://localhost:3001](http://localhost:3001) to view your new MooseJS application console. As you develop your MooseJS application, changes you make to your code base will be automatically reflected here in real time.
13 changes: 10 additions & 3 deletions apps/framework-docs/src/pages/moose-cli.mdx
Original file line number Diff line number Diff line change
@@ -1,23 +1,30 @@
import { Steps } from 'nextra/components'

# Installation

MooseJS comes with a handy CLI for managing your MooseJS application. Navigate to your project's directory to run commands. There are few ways to run the CLI:

1. The simplest method to run the CLI is via NPX. No extra installation is necessary for this method.
<Steps>
### NPX
The simplest method to run the CLI is via NPX. No extra installation is necessary for this method.
```txt filename="Terminal" copy
npx @514labs/moose-cli <command>
```

2. Alternatively, the Moose CLI comes packaged with your Moose application. You can install the dependency locally and then run the Moose CLI within your project with:
### Dependency install
Alternatively, the Moose CLI comes packaged with your Moose application. You can install the dependency locally and then run the Moose CLI within your project with:
```txt filename="Terminal" copy
npm install
npm run <command>
```

3. Finally, you can install the Moose CLI globally using NPM. This will get you a cleaner command interface, and better performance on the CLI. You can then run the Moose CLI anywhere.
### Global install
Finally, you can install the Moose CLI globally using NPM. This will get you a cleaner command interface, and better performance on the CLI. You can then run the Moose CLI anywhere.
```txt filename="Terminal" copy
npm install -g @514labs/moose-cli
moose <command>
```
</Steps>

# Moose CLI commands

Expand Down

0 comments on commit a5e7102

Please sign in to comment.