Skip to content

Commit 800df87

Browse files
committed
make contributions easier with the online development setup.
1 parent e420745 commit 800df87

3 files changed

Lines changed: 13 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 && yarn bootstrap
3+
4+
vscode:
5+
extensions:
6+
- esbenp.prettier-vscode@5.7.1:GDba64T6G+TUi1qmc6BE3A==

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ Follow these steps to get your code PR-ready:
3838
6. Update `CHANGELOG.md`.
3939
7. Ensure your changes build by running `yarn build` in the appropriate package directory(s).
4040

41+
## Online one-click setup
42+
43+
You can use Gitpod(an online IDE which is free for Open Source) for developing online. With a single click it will launch a workspace and automatically: clone the `popmoton` repo and run `yarn install` && `yarn bootstrap` so that anyone interested can start straight away.
44+
45+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
46+
4147
## Codebase Overview
4248

4349
Other than [Stylefire](https://github.com/popmotion/stylefire) and [Framesync](https://github.com/popmotion/framesync), Popmotion is a monorepo. All Popmotion and Pose packages are contained in the [`packages` directory](https://github.com/Popmotion/popmotion/tree/master/packages).

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![npm version](https://img.shields.io/npm/v/popmotion.svg?style=flat-square)](https://www.npmjs.com/package/popmotion)
66
[![npm downloads](https://img.shields.io/npm/dm/popmotion.svg?style=flat-square)](https://www.npmjs.com/package/popmotion)
77
[![Twitter Follow](https://img.shields.io/twitter/follow/popmotionjs.svg?style=social&label=Follow)](http://twitter.com/popmotionjs)
8+
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
89

910
Popmotion is:
1011
- **Powerful**: It supports keyframe and spring animations for numbers, colors and complex strings.

0 commit comments

Comments
 (0)