Skip to content

Commit

Permalink
fully automate the dev setup with Gitpod. (TanStack#1155)
Browse files Browse the repository at this point in the history
  • Loading branch information
nisarhassan12 authored Oct 10, 2020
1 parent 07f06b9 commit 812f1e9
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
tasks:
- name: Auto Build
init: |
yarn install
gp sync-done boot
command: yarn run start

- name: Docs
before: cd docs/
init: |
gp sync-await boot
yarn install
command: yarn dev
openMode: split-right

ports:
- port: 3000
onOpen: open-preview
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ If you have been assigned to fix an issue or develop a new feature, please follo
- Git stage your required changes and commit (see below commit guidelines)
- Submit PR for review

## Online one-click setup

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:

- clone the `react-query` repo.
- install all the dependencies in `/` and `/docs`.
- run `yarn start` in the root(`/`) to Auto-build files.
- run `yarn dev` in `/docs`.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)

## Commit message conventions

`react-query` is using [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Hooks for fetching, caching and updating asynchronous data in React
<img alt="" src="https://img.shields.io/github/stars/tannerlinsley/react-query.svg?style=social&label=Star" />
</a><a href="https://twitter.com/tannerlinsley" target="\_parent">
<img alt="" src="https://img.shields.io/twitter/follow/tannerlinsley.svg?style=social&label=Follow" />
</a> <a href="https://gitpod.io/from-referrer/">
<img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"/>
</a>

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)
Expand Down

0 comments on commit 812f1e9

Please sign in to comment.