diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000000..8088f1a9af --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,6 @@ +tasks: + - init: yarn install + command: yarn run dev +ports: + - port: 8000 + onOpen: open-preview diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9bfa05d53..09974e06b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,6 +90,13 @@ We like feature requests but make sure that it can be seen within the goals of t - Issues without a [Codepen](#code-examples) (where applicable) will be closed or ignored. - Use this [Codepen](http://codepen.io/Dogfalo/pen/xbzPQV) to illustrate your problem. +## Contribute using Online one-click setup + +With a single click the one-click online setup you'll get a ready to code workspace where the repo is already cloned, all the dependencies pre-installed and `npm run dev` running so that you can start straight away wihout wasting time on the setup. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) + + ## Pull requests Good pull requests - patches, improvements, new features - are a fantastic help. Thanks for taking the time to contribute. diff --git a/README.md b/README.md index e89aca1b32..7f488ff9bc 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,9 @@ Gitter badge + + Gitpod Ready-to-Code +

## Table of Contents @@ -65,6 +68,13 @@ npm install Then run `grunt monitor` to compile the documentation. When it finishes, open a new browser window and navigate to `localhost:8000`. We use [BrowserSync](https://www.browsersync.io/) to display the documentation. +## Online one-click setup + +With a single click the one-click online setup you'll get a ready to code workspace where the repo is already cloned, all the dependencies pre-installed and `npm run dev` running so that you can start straight away wihout wasting time on the setup. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) + + ### Documentation for previous releases Previous releases and their documentation are available for [download](https://github.com/Dogfalo/materialize/releases).