From 523fd0e83323f10d4a92bb625abd4a9944aff2b0 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Sun, 11 Oct 2020 11:29:26 +0500 Subject: [PATCH] simplify code contributions + reviews by fully automating the dev setup with Gitpod. (#824) --- .gitpod.Dockerfile | 4 ++++ .gitpod.yml | 10 ++++++++++ README.md | 10 ++++++++++ 3 files changed, 24 insertions(+) create mode 100644 .gitpod.Dockerfile create mode 100644 .gitpod.yml diff --git a/.gitpod.Dockerfile b/.gitpod.Dockerfile new file mode 100644 index 00000000..41956947 --- /dev/null +++ b/.gitpod.Dockerfile @@ -0,0 +1,4 @@ +FROM gitpod/workspace-full + +RUN sudo apt-get update \ + && sudo apt install ffmpeg -yq diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 00000000..18373c95 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,10 @@ +image: + file: .gitpod.Dockerfile +tasks: + - init: yarn && gp sync-done boot + - before: cd gulp + init: gp sync-await boot && yarn + command: yarn gulp +ports: + - port: 3005 + onOpen: open-preview diff --git a/README.md b/README.md index 00e57ecc..85b5d26b 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,16 @@ Your goal is to produce shapes by cutting, rotating, merging and painting parts **Notice**: This will produce a debug build with several debugging flags enabled. If you want to disable them, modify [`src/js/core/config.js`](src/js/core/config.js). +## Build Online with one-click setup + +You can use [Gitpod](https://www.gitpod.io/) (an Online Open Source VS Code-like IDE which is free for Open Source) for working on issues and making PRs to this project. With a single click it will start a workspace and automatically: + +- clone the `shapez.io` repo. +- install all of the dependencies. +- start `gulp` in `gulp/` directory. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) + ## Helping translate Please checkout the [Translations readme](translations/).