Skip to content

Commit 34cf0ce

Browse files
committed
quick start
1 parent 534a8e5 commit 34cf0ce

File tree

1 file changed

+64
-7
lines changed

1 file changed

+64
-7
lines changed

src/routes/getting-started/quick-start.mdx

Lines changed: 64 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Quick Start Guide
2+
title: Quick Start
33
order: 1
44
---
55

@@ -15,12 +15,69 @@ If you prefer a more complete development setup, you can use the StackBlitz [Jav
1515
## Create a New Project
1616

1717
:::note[Before You Begin]
18-
Make sure you have a recent version of your prefer JavaScript runtime installed, such as [Node.js](https://nodejs.org/en), [Bun](https://bun.sh/), or [Deno](https://deno.com/).
18+
Make sure you have a recent version of your preferred JavaScript runtime installed, such as [Node.js](https://nodejs.org/en), [Bun](https://bun.sh/), or [Deno](https://deno.com/).
1919
:::
2020

21-
[TODO]
21+
To create a new Solid project, follow these steps:
2222

23-
- Navigate to directory and run command
24-
- CLI will take you through options
25-
- Once you've selected your options, the CLI will prompt you to install the dependencies and start the development server
26-
- Open browser and navigate to the provided local URL to see your new Solid app in action!
23+
1. **Open your terminal and navigate to the directory** where you want to create your project.
24+
25+
2. **Run the following command:**
26+
27+
```package-create
28+
solid
29+
```
30+
31+
3. **Follow the CLI prompts** to select your project name, template (JavaScript or TypeScript), and other options.
32+
33+
```sh
34+
◆ Project Name
35+
| <solid-project>
36+
37+
◆ Is this a SolidStart project?
38+
| ● Yes / ○ No
39+
40+
◆ Which template would you like to use?
41+
│ ● ts
42+
│ ○ ts-vitest
43+
│ ○ ts-uvu
44+
│ ○ ts-unocss
45+
│ ○ ts-tailwindcss
46+
47+
◆ Use TypeScript?
48+
│ ● Yes / ○ No
49+
```
50+
51+
4. **Follow the instructions to install the dependencies and start the development server:**
52+
53+
```sh title="npm" tab="package-manager"
54+
cd solid-project
55+
npm install
56+
npm run dev
57+
```
58+
59+
```sh title="pnpm" tab="package-manager"
60+
cd solid-project
61+
pnpm install
62+
pnpm dev
63+
```
64+
65+
```sh title="yarn" tab="package-manager"
66+
cd solid-project
67+
yarn install
68+
yarn dev
69+
```
70+
71+
```sh title="bun" tab="package-manager"
72+
cd solid-project
73+
bun install
74+
bun run dev
75+
```
76+
77+
```sh title="deno" tab="package-manager"
78+
cd solid-project
79+
deno install
80+
deno run dev
81+
```
82+
83+
6. **Open your browser and go to the local URL** provided in the terminal to see your new Solid app in action!

0 commit comments

Comments
 (0)