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.

Sign up for GitHub

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

Jump to bottom

Update install doc with cmd to launch #206

Merged
merged 1 commit into from
Feb 9, 2023
Merged

Update install doc with cmd to launch #206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ There are a variety of ways to install SMK into your application.
## Use `smk create`

If you want to create a new application using SMK, then the easiest way is with the `smk-cli`.

`smk-cli` makes use of the Node.js JavaScript runtime and the Node Package Manager (NPM). If this is not already installed, please [download](https://nodejs.org/en/download/) and install it.

First make sure that the `smk-cli` is installed globally in your machine:

> npm install --global @bcgov/smk-cli
Expand All @@ -26,6 +29,11 @@ Change to the a directory where you keep your projects, and create a new SMK app
You will be asked some questions about your new application.
Once they are answered you will have a new skeleton application at `projects/my-new-app`.

You will also be asked whether you want to run the app. You can choose yes to launch the app immediately.

You can also run the app at a later time by navigating to the app directory and launching it with NPM:

> npm run view

## Install from NPM

Expand Down