diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000000..7639205ec9 --- /dev/null +++ b/.gitpod.yml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12f7ca6dde..7a32287c3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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). diff --git a/README.md b/README.md index 969d01eadc..d9c35dc0b9 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ Hooks for fetching, caching and updating asynchronous data in React + + Gitpod Ready-to-Code 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)