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.

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

Adding Gitpod ready-to-code #40

Merged
merged 16 commits into from Jul 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion .gitignore
Expand Up @@ -2,7 +2,6 @@
storybook-static/
custom-elements.json
.env
.npmrc
.aws
.hidden
*.lit.ts
Expand Down
11 changes: 11 additions & 0 deletions .gitpod.Dockerfile
@@ -0,0 +1,11 @@
FROM gitpod/workspace-full

RUN sudo apt-get -qq update

USER gitpod

# Fix node version we develop against
ARG OUTLINE_NODE_VERSION=16
RUN bash -c ". .nvm/nvm.sh \
&& nvm install $OUTLINE_NODE_VERSION"
ENV PATH=/home/gitpod/.nvm/versions/node/v${OUTLINE_NODE_VERSION}/bin:$PATH
43 changes: 43 additions & 0 deletions .gitpod.yml
@@ -0,0 +1,43 @@
image:
file: .gitpod.Dockerfile

tasks:
- init: |
nvm install 16
yarn
command: |
nvm install 16
yarn start

vscode:
extensions:
- bradlc.vscode-tailwindcss
- pranaygp.vscode-css-peek
- runem.lit-plugin
- silvenon.mdx
- streetsidesoftware.code-spell-checker

ports:
# Used by Storybook
- port: 6006
onOpen: open-preview
visibility: private

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: true
# 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
1 change: 1 addition & 0 deletions .npmrc
@@ -0,0 +1 @@
engine-strict=true
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -6,7 +6,13 @@

We have a [Code of Conduct](https://github.com/phase2/outline/blob/next/CODE_OF_CONDUCT.md), please follow it in all interactions with project maintainers and fellow users.

## Setup
## Using Gitpod

If you have a web browser, you can get a fully pre-configured development environment with one click:

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/phase2/outline)

## Local Setup

Run the following steps to ensure your environment is installed and up to date. This assumes you are using [NVM](https://github.com/nvm-sh/nvm) locally to manage your NPM version(s).

Expand Down
2 changes: 2 additions & 0 deletions README.md
@@ -1,3 +1,5 @@
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)

# Outline Design System

Outline is a [web component](https://developer.mozilla.org/en-US/docs/Web/Web_Components) based design system starter kit. Outline is based on the latest technologies and tools to help your component authoring experience and facilitate adoption in your organization.
Expand Down
4 changes: 3 additions & 1 deletion package.json
Expand Up @@ -25,7 +25,6 @@
],
"license": "BSD-3-Clause",
"scripts": {
"preinstall": "npx check-node-version --node $(cat .nvmrc)",
"prestart": "yarn prep",
"start": "yarn storybook.dev.watch",
"prep": "yarn generate.safelist && yarn postcss.storybook && yarn generate.resolved-tailwind && yarn generate.custom-elements && yarn generate.component-css",
Expand Down Expand Up @@ -69,6 +68,9 @@
"dependencies": {
"lit": "^2.0.0-rc.2"
},
"engines": {
"node": ">=16"
},
"devDependencies": {
"@babel/plugin-proposal-class-properties": "^7.13.0",
"@babel/plugin-proposal-decorators": "^7.14.2",
Expand Down