Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make onboarding even simpler for VS Code users #2044

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −5
Open

Make onboarding even simpler for VS Code users #2044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion .vscode/extensions.json
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@
"mikestead.dotenv",
"streetsidesoftware.code-spell-checker",
"vscode-icons-team.vscode-icons",
"zixuanchen.vitest-explorer"
"zixuanchen.vitest-explorer",
"stateful.runme"
]
}
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Expand Up @@ -5,6 +5,7 @@
<a href="https://discord.gg/2nKEnKq"><img src="https://img.shields.io/discord/643523529131950086?label=Chat" height="20"></a>
<a href="https://github.com/kriasoft/react-starter-kit/stargazers"><img src="https://img.shields.io/github/stars/kriasoft/react-starter-kit.svg?style=social&label=Star&maxAge=3600" height="20"></a>
<a href="https://twitter.com/koistya"><img src="https://img.shields.io/twitter/follow/koistya.svg?style=social&label=Follow&maxAge=3600" height="20"></a>
<a href="https://runme.dev/api/runme?repository=https%3A%2F%2Fgithub.com%2Fkriasoft%2Freact-starter-kit.git&fileToOpen=README.md"><img src="https://badgen.net/badge/Run%20this%20/README/5B3ADF?icon=https://runme.dev/img/logo.svg" height="20"></a>

The web's most popular Jamstack front-end template for building web applications with
[React](https://react.dev/).
Expand Down Expand Up @@ -52,19 +53,26 @@ Be sure to join our [Discord channel](https://discord.com/invite/2nKEnKq) for as

## Getting Started

[Generate](https://github.com/kriasoft/react-starter-kit/generate) a new project
from this template, clone it, install project dependencies, update the
environment variables found in [`env/*.env`](./env/), and start hacking:
[Generate](https://github.com/kriasoft/react-starter-kit/generate) a new project from this template by clicking [this link](https://runme.dev/api/runme?repository=https%3A%2F%2Fgithub.com%2Fkriasoft%2Freact-starter-kit.git&fileToOpen=README.md) if you are a VS Code user or manually clone it via:

```
```bash
$ git clone https://github.com/kriasoft/react-starter-kit.git example
$ cd ./example
```

Then install project dependencies, update the environment variables found in [`env/*.env`](./env/), and start hacking:

```bash
$ yarn install
$ yarn start
```

The app will become available at [http://localhost:5173/](http://localhost:5173/) (press `q` key to exit).

```bash
open http://localhost:5173/
```

**IMPORTANT**: Ensure that VSCode is using the workspace [version of TypeScript](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-newer-typescript-versions)
and ESLint.

Expand Down