diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000..86dbcb8 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,16 @@ +tasks: + - init: > + git clone https://github.com/algorithm-visualizer/server.git && + cd server && + echo -e "GITHUB_CLIENT_ID=dummy\nGITHUB_CLIENT_SECRET=dummy" > .env.local && npm install && + cd .. + command: cd server && npm run watch + - init: > + npm install && + echo 'DANGEROUSLY_DISABLE_HOST_CHECK=true' > .env + command: npm start +ports: + - port: 3000 + onOpen: notify + - port: 8080 + onOpen: ignore diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b07a56..fffae81 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,7 @@ > #### Table of Contents > - [Running Locally](#running-locally) +> - [Run in Gitpod](#run-in-gitpod) > - [Directory Structure](#directory-structure) Are you a first-timer in contributing to open source? [These guidelines](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) from GitHub might help! @@ -37,6 +38,12 @@ Are you a first-timer in contributing to open source? [These guidelines](https:/ 5. Open [`http://localhost:3000/`](http://localhost:3000/) in a web browser. +## Run in Gitpod + +You can also run algorithm-visualizer in Gitpod, a free online dev environment for GitHub. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/algorithm-visualizer/algorithm-visualizer) + ## Directory Structure - [**branding/**](branding) contains representative image files.