Skip to content

Commit 4e29cc0

Browse files
committed
Add Sarah's suggestions
1 parent 220958c commit 4e29cc0

File tree

1 file changed

+34
-28
lines changed

1 file changed

+34
-28
lines changed

src/routes/quick-start.mdx

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,52 @@ title: Quick start
44

55
## Try Solid online
66

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.
1210

1311
## Create a Solid project
1412

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:
1623

1724
```package-create
1825
solid
1926
```
2027

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):
2930

30-
If you are uncertain about an option, simply choose the default by pressing enter.
31+
```shell
32+
◆ Project Name
33+
| <solid-project>
3134

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
3337

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
3544

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+
```
4048

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:
4350

51+
```shell
52+
cd solid-project
53+
│ npm install
54+
│ npm run dev
4455
```
45-
https://stackblitz.com/github/solidjs/templates/tree/master/<template-name>
46-
```
47-
48-
For example, the link below opens a complete development environment in your browser for the TypeScript template:
49-
[https://stackblitz.com/github/solidjs/templates/tree/master/ts](https://stackblitz.com/github/solidjs/templates/tree/master/ts)

0 commit comments

Comments
 (0)