From 14f1e7cb00d7122c4ae2b10cfc04512ca75f8eb7 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Fri, 13 Mar 2020 09:40:36 +0000 Subject: [PATCH] simplify contributions by fully automating the dev setup with gitpod. --- .gitpod.yml | 6 ++++++ CONTRIBUTING.md | 12 ++++++++++++ README.md | 15 +++++++++++++++ 3 files changed, 33 insertions(+) create mode 100644 .gitpod.yml 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..d995e65f23 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,6 +90,18 @@ 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. +## Online one-click setup for contributing + +You can use Gitpod (a free VS Code-like IDE) for the online one-click setup with a single click it'll launch a workspace and automatically: + +- clone the materialize repo. +- install the dependencies. +- start `npm run dev`. + +so that you can start coding straight away. + +[![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..988d741675 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,9 @@ Gitter badge + + Gitpod Ready-to-Code +

## Table of Contents @@ -65,6 +68,18 @@ 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 + +You can use Gitpod (a free VS Code-like IDE) for the online one-click setup with a single click it'll launch a workspace and automatically: + +- clone the materialize repo. +- install the dependencies. +- start `npm run dev`. + +so that you can start coding straight away. + +[![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).