Skip to content

Make onboarding even simpler for VS Code users #372

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make onboarding even simpler for VS Code users #372

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"mikestead.dotenv",
"orta.vscode-jest",
"streetsidesoftware.code-spell-checker",
"vscode-icons-team.vscode-icons"
"vscode-icons-team.vscode-icons",
"stateful.runme"
]
}
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,16 @@ Be sure to join our [Discord channel](https://discord.com/invite/bSsv7XM) for as

## Getting Started

Just [clone](https://github.com/kriasoft/relay-starter-kit/generate) the repo
and run `yarn install` followed by `yarn start`:
Just [clone](https://github.com/kriasoft/relay-starter-kit/generate) the repo or if you are using VS Code, [click here](https://runme.dev/api/runme?repository=https%3A%2F%2Fgithub.com%2Fkriasoft%2Frelay-starter-kit.git&fileToOpen=README.md).

```bash
$ git clone https://github.com/kriasoft/relay-starter-kit.git example
$ cd ./example # Change current directory to the newly created one
```

Then install dependencies and run `yarn install` followed by `yarn start`:

```bash
$ yarn install # Install project dependencies
$ yarn setup # Configure environment variables
$ yarn db:reset # Create or update PostgreSQL database
Expand Down