You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/routes/quick-start.mdx
+34-28Lines changed: 34 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,46 +4,52 @@ title: Quick start
4
4
5
5
## Try Solid online
6
6
7
-
If you want to experiment with Solid in your browser, visit our [interactive playground](https://playground.solidjs.com/).
8
-
9
-
You can also set up a complete build environment directly in your browser using StackBlitz.
10
-
To get started, try the [TypeScript](https://stackblitz.com/github/solidjs/templates/tree/master/ts) or [JavaScript](https://stackblitz.com/github/solidjs/templates/tree/master/js) templates.
11
-
Solid offers many more templates, which you can explore in the [starter templates](#starter-templates) section.
7
+
To experiment with Solid directly in your browser, head over to our [interactive playground](https://playground.solidjs.com/).
8
+
Prefer a full development setup? You can set up a complete environment using StackBlitz.
9
+
Start with the [TypeScript](https://stackblitz.com/github/solidjs/templates/tree/master/ts) or [JavaScript](https://stackblitz.com/github/solidjs/templates/tree/master/js) templates.
12
10
13
11
## Create a Solid project
14
12
15
-
You can create a new Solid application using the Solid CLI:
13
+
:::info[Prerequisites]
14
+
15
+
- Familiarity with the command line.
16
+
- An updated [Node.js](https://nodejs.org/en) or [Deno](https://deno.com) installation.
17
+
18
+
:::
19
+
20
+
To create a new Solid application, start by installing the Solid CLI.
21
+
First, ensure you have an up-to-date version of [Node.js](https://nodejs.org/) installed.
22
+
Then, navigate to the directory where you want to create your project and run the following command:
16
23
17
24
```package-create
18
25
solid
19
26
```
20
27
21
-
The CLI will prompt you for a few details about your project:
22
-
23
-
- The name of your project.
24
-
- Whether you want to use [SolidStart](/solid-start).
25
-
For full-stack projects, we recommend using SolidStart.
26
-
SolidStart is a meta-framework for Solid that provides features such as file-based routing, nested routing, and multiple rendering modes.
27
-
- The [starter template](#starter-templates) you wish to use.
28
-
- Whether you want to use TypeScript.
28
+
This command installs and runs [create-solid](https://github.com/solidjs-community/solid-cli/tree/main/packages/create-solid), the official project scaffolding tool for Solid.
29
+
The CLI will guide you through a series of prompts, allowing you to choose options such as [starter templates](https://github.com/solidjs/templates), TypeScript support, and whether to include [Solid's full-stack framework, SolidStart](/solid-start):
29
30
30
-
If you are uncertain about an option, simply choose the default by pressing enter.
31
+
```shell
32
+
◆ Project Name
33
+
|<solid-project>
31
34
32
-
Once the project is created, follow the on-screen instructions to install dependencies and run the development server.
35
+
◆ Is this a SolidStart project?
36
+
| ● Yes / ○ No
33
37
34
-
## Starter templates
38
+
◆ Which template would you like to use?
39
+
│ ● ts
40
+
│ ○ ts-vitest
41
+
│ ○ ts-uvu
42
+
│ ○ ts-unocss
43
+
│ ○ ts-tailwindcss
35
44
36
-
Solid offers a variety of starter templates for popular frameworks and libraries.
37
-
You can see all of them the [templates repository](https://github.com/solidjs/templates).
38
-
39
-
The best way to kickstart your project with one of the templates is using the Solid CLI.
45
+
◆ Use TypeScript?
46
+
│ ● Yes / ○ No
47
+
```
40
48
41
-
Additionally, you can try the templates directly in your browser using [StackBlitz](https://stackblitz.com/).
42
-
To do this, replace `<template-name>` in the following URL with the name of the template you want to use, and open it in your browser:
49
+
Once the project is created, follow the instructions to install the dependencies and start the development server:
0 commit comments