Skip to content
Merged
Changes from 1 commit
Commits
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
62 changes: 34 additions & 28 deletions src/routes/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,52 @@ title: Quick start

## Try Solid online

If you want to experiment with Solid in your browser, visit our [interactive playground](https://playground.solidjs.com/).

You can also set up a complete build environment directly in your browser using StackBlitz.
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.
Solid offers many more templates, which you can explore in the [starter templates](#starter-templates) section.
To experiment with Solid directly in your browser, head over to our [interactive playground](https://playground.solidjs.com/).
Prefer a full development setup? You can set up a complete environment using StackBlitz.
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.

## Create a Solid project

You can create a new Solid application using the Solid CLI:
:::info[Prerequisites]

- Familiarity with the command line.
- An updated [Node.js](https://nodejs.org/en) or [Deno](https://deno.com) installation.

:::

To create a new Solid application, start by installing the Solid CLI.
First, ensure you have an up-to-date version of [Node.js](https://nodejs.org/) installed.
Comment thread
amirhhashemi marked this conversation as resolved.
Outdated
Then, navigate to the directory where you want to create your project and run the following command:

```package-create
solid
```

The CLI will prompt you for a few details about your project:

- The name of your project.
- Whether you want to use [SolidStart](/solid-start).
For full-stack projects, we recommend using SolidStart.
SolidStart is a meta-framework for Solid that provides features such as file-based routing, nested routing, and multiple rendering modes.
- The [starter template](#starter-templates) you wish to use.
- Whether you want to use TypeScript.
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.
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):

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

Once the project is created, follow the on-screen instructions to install dependencies and run the development server.
◆ Is this a SolidStart project?
| ● Yes / ○ No

## Starter templates
◆ Which template would you like to use?
│ ● ts
│ ○ ts-vitest
│ ○ ts-uvu
│ ○ ts-unocss
│ ○ ts-tailwindcss

Solid offers a variety of starter templates for popular frameworks and libraries.
You can see all of them the [templates repository](https://github.com/solidjs/templates).

The best way to kickstart your project with one of the templates is using the Solid CLI.
◆ Use TypeScript?
│ ● Yes / ○ No
```

Additionally, you can try the templates directly in your browser using [StackBlitz](https://stackblitz.com/).
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:
Once the project is created, follow the instructions to install the dependencies and start the development server:

```shell
│ cd solid-project
│ npm install
│ npm run dev
```
Comment thread
LadyBluenotes marked this conversation as resolved.
https://stackblitz.com/github/solidjs/templates/tree/master/<template-name>
```

For example, the link below opens a complete development environment in your browser for the TypeScript template:
[https://stackblitz.com/github/solidjs/templates/tree/master/ts](https://stackblitz.com/github/solidjs/templates/tree/master/ts)