Skip to content

Commit f6ccb1c

Browse files
peterb-lrstoenescu
andauthored
feat(docs): Refine quick-start.md (#18067)
* Update quick-start.md Fixing some minor omissions necessary to make the quick start work. * Update quick-start.md * Refine quick start guide for Quasar CLI --------- Co-authored-by: Razvan Stoenescu <razvan.stoenescu@gmail.com>
1 parent decbe86 commit f6ccb1c

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

docs/src/pages/start/quick-start.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ If you are a more advanced Vue developer, we invite you to start off by [decidin
1313
Make sure that you have Node >=20 (or any newer **LTS Node.js version**) and NPM v6+ or Yarn v1 (classic) or PNPM v8+ installed on your machine. Please do not use any odd versions of Node, as these are [considered experimental](https://nodejs.org/en/about/previous-releases).
1414

1515
## Step 1: Create a Project
16+
Navigate to the folder above where you want your project to be. Quasar will later prompt you for the name of the project folder and create that folder within this.
1617

1718
Enter the following command:
1819

@@ -28,7 +29,7 @@ $ pnpm create quasar@latest
2829
$ bun create quasar@latest
2930
```
3031

31-
As the `create` or `init` command runs, you'll be prompted with some options. Depending on your needs, you can select the CLI type (Vite or Webpack) and you can add things like TypeScript support or a different CSS preprocessor. If you are unsure about any of the options, just take the defaults (hit enter) and you'll be good to go. You can change the options, except for the CLI type, later if you wish.
32+
As the command above runs, you'll be prompted with some options. Depending on your needs, you can select the CLI type (Vite or Webpack) and you can add things like TypeScript support or a different CSS preprocessor. If you are unsure about any of the options, just take the defaults (hit enter) and you'll be good to go. You can change the options, except for the CLI type, later if you wish.
3233

3334
### Optional - Install the Global CLI
3435
For doing more with Quasar, you should also install the global CLI. With it you can directly run Quasar commands in the terminal, run a local http server for testing or do upgrades on your project.
@@ -49,14 +50,27 @@ $ bun install -g @quasar/cli
4950

5051
For the second and last step, navigate into the newly created project folder and run the Quasar CLI command to start the dev server.
5152

52-
```bash
53-
$ cd <project_folder_name>
54-
# then run:
55-
53+
```tabs
54+
<<| bash Yarn |>>
55+
# if you have the global CLI:
56+
$ quasar dev
57+
# otherwise:
58+
$ yarn quasar dev
59+
<<| bash NPM |>>
60+
# if you have the global CLI:
61+
$ quasar dev
62+
# otherwise:
63+
$ npm run dev
64+
<<| bash PNPM |>>
65+
# if you have the global CLI:
66+
$ quasar dev
67+
# otherwise:
68+
$ pnpm run dev
69+
<<| bash Bun |>>
5670
# if you have the global CLI:
5771
$ quasar dev
5872
# otherwise:
59-
$ yarn quasar dev # or: npx quasar dev
73+
$ bun run dev
6074
```
6175

6276
You'll see the dev server compiling your new application and once it is finished, your new app should open up in your browser. That's it! You can now develop your app with your favorite IDE/ Code Editor.

0 commit comments

Comments
 (0)