simplifies code contributions by fully automating the dev setup with gitpod.

This commit is contained in:
Nisar Hassan Naqvi 2020-03-16 12:13:46 +00:00
parent 4613bbc754
commit 6e29f02f79
2 changed files with 23 additions and 0 deletions

10
.gitpod.yml Normal file
View File

@ -0,0 +1,10 @@
tasks:
- init: yarn install
command: yarn run start
ports:
- port: 3000
onOpen: open-preview
vscode:
extensions:
- octref.vetur@0.23.0:0z6KpEz8h/vAvy4pYRDg3Q==

View File

@ -1,6 +1,7 @@
# tiptap
A renderless and extendable rich-text editor for [Vue.js](https://github.com/vuejs/vue)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/scrumpy/tiptap)
[![](https://img.shields.io/npm/v/tiptap.svg?label=version)](https://www.npmjs.com/package/tiptap)
[![](https://img.shields.io/npm/dm/tiptap.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
[![](https://img.shields.io/npm/l/tiptap.svg)](https://www.npmjs.com/package/tiptap)
@ -477,6 +478,18 @@ yarn build:packages
yarn build:examples
```
## Contribute using the online one-click setup
You can use Gitpod(a free online VS Code-like IDE) for contributing. With a single click, it will launch a workspace and automatically:
- clone the `tiptap` repo.
- install the dependencies.
- run `yarn run start`.
So that anyone interested in contributing can start straight away.
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/scrumpy/tiptap/)
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.