Skip to content

Commit

Permalink
simplify contributions by fully automating the dev setup with gitpod.
Browse files Browse the repository at this point in the history
  • Loading branch information
nisarhassan12 committed Feb 24, 2020
1 parent 07189de commit ac0a031
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
tasks:
- init: yarn install
command: yarn run dev
ports:
- port: 8000
onOpen: open-preview
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
<a href="https://gitter.im/Dogfalo/materialize">
<img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter badge">
</a>
<a href="https://gitpod.io/#https://github.com/Dogfalo/materialize">
<img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code">
</a>
</p>

## Table of Contents
Expand Down Expand Up @@ -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).

Expand Down

0 comments on commit ac0a031

Please sign in to comment.