Skip to content

Commit 812f1e9

Browse files
fully automate the dev setup with Gitpod. (TanStack#1155)
1 parent 07f06b9 commit 812f1e9

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

.gitpod.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
tasks:
2+
- name: Auto Build
3+
init: |
4+
yarn install
5+
gp sync-done boot
6+
command: yarn run start
7+
8+
- name: Docs
9+
before: cd docs/
10+
init: |
11+
gp sync-await boot
12+
yarn install
13+
command: yarn dev
14+
openMode: split-right
15+
16+
ports:
17+
- port: 3000
18+
onOpen: open-preview

CONTRIBUTING.md

+11
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,17 @@ If you have been assigned to fix an issue or develop a new feature, please follo
2727
- Git stage your required changes and commit (see below commit guidelines)
2828
- Submit PR for review
2929

30+
## Online one-click setup
31+
32+
You can use Gitpod(An Online Open Source VS Code like IDE which is free for Open Source) for developing online. With a single click it will start a workspace and automatically:
33+
34+
- clone the `react-query` repo.
35+
- install all the dependencies in `/` and `/docs`.
36+
- run `yarn start` in the root(`/`) to Auto-build files.
37+
- run `yarn dev` in `/docs`.
38+
39+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
40+
3041
## Commit message conventions
3142

3243
`react-query` is using [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Hooks for fetching, caching and updating asynchronous data in React
2020
<img alt="" src="https://img.shields.io/github/stars/tannerlinsley/react-query.svg?style=social&label=Star" />
2121
</a><a href="https://twitter.com/tannerlinsley" target="\_parent">
2222
<img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
23+
</a> <a href="https://gitpod.io/from-referrer/">
24+
<img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"/>
2325
</a>
2426

2527
Enjoy this library? Try the entire [TanStack](https://tanstack.com)! [React Table](https://github.com/tannerlinsley/react-table), [React Form](https://github.com/tannerlinsley/react-form), [React Charts](https://github.com/tannerlinsley/react-charts)

0 commit comments

Comments
 (0)