Skip to content

Commit

Permalink
Adding Gitpod support (#661)
Browse files Browse the repository at this point in the history
* Adding Gitpod setup

* remove specifying vscode extensions in gitpod

* Allow ports 4000-4999

* Make local dev env instructions the first option
  • Loading branch information
shaal committed Feb 1, 2022
1 parent fbec7bd commit 9cfb652
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
tasks:
- init: npm install && npm run build
command: npm run start

ports:
- port: 3001
onOpen: ignore
- port: 4000-4999
onOpen: open-preview

github:
prebuilds:
# enable for the master/default branch (defaults to true)
master: true
# enable for all branches in this repo (defaults to false)
branches: true
# enable for pull requests coming from this repo (defaults to true)
pullRequests: true
# enable for pull requests coming from forks (defaults to false)
pullRequestsFromForks: true
# add a check to pull requests (defaults to true)
addCheck: true
# add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
addComment: false
# add a "Review in Gitpod" button to the pull request's description (defaults to false)
addBadge: true
# add a label once the prebuild is ready to pull requests (defaults to false)
addLabel: true
3 changes: 3 additions & 0 deletions docs/resources/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ npm run start

After the initial build, a browser will open automatically to a local version of the docs. The documentation is powered by Docsify, which uses raw markdown files to generate pages on the fly.

Alternatively, you can use Gitpod for a dev environment in the cloud (no local setup is needed, everything is done through your browser)
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/shoelace-style/shoelace)

### Creating New Components

To scaffold a new component, run the following command, replacing `sl-tag-name` with the desired tag name.
Expand Down

0 comments on commit 9cfb652

Please sign in to comment.