Skip to content

Commit 14f1e7c

Browse files
committed
simplify contributions by fully automating the dev setup with gitpod.
1 parent 07189de commit 14f1e7c

3 files changed

Lines changed: 33 additions & 0 deletions

File tree

.gitpod.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
tasks:
2+
- init: yarn install
3+
command: yarn run dev
4+
ports:
5+
- port: 8000
6+
onOpen: open-preview

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,18 @@ We like feature requests but make sure that it can be seen within the goals of t
9090
- Issues without a [Codepen](#code-examples) (where applicable) will be closed or ignored.
9191
- Use this [Codepen](http://codepen.io/Dogfalo/pen/xbzPQV) to illustrate your problem.
9292

93+
## Online one-click setup for contributing
94+
95+
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:
96+
97+
- clone the materialize repo.
98+
- install the dependencies.
99+
- start `npm run dev`.
100+
101+
so that you can start coding straight away.
102+
103+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
104+
93105
## Pull requests
94106

95107
Good pull requests - patches, improvements, new features - are a fantastic help. Thanks for taking the time to contribute.

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@
3030
<a href="https://gitter.im/Dogfalo/materialize">
3131
<img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter badge">
3232
</a>
33+
<a href="https://gitpod.io/#https://github.com/Dogfalo/materialize">
34+
<img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code">
35+
</a>
3336
</p>
3437

3538
## Table of Contents
@@ -65,6 +68,18 @@ npm install
6568

6669
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.
6770

71+
## Online one-click setup
72+
73+
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:
74+
75+
- clone the materialize repo.
76+
- install the dependencies.
77+
- start `npm run dev`.
78+
79+
so that you can start coding straight away.
80+
81+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
82+
6883
### Documentation for previous releases
6984
Previous releases and their documentation are available for [download](https://github.com/Dogfalo/materialize/releases).
7085

0 commit comments

Comments
 (0)