Mono-repo configuration

Author: coyotte508

viewer/.editorconfig .editorconfig

@@ -0,0 +1 @@
+node_modules

.gitignore

@@ -0,0 +1,3 @@
+FROM gitpod/workspace-full
+
+RUN npm install -g pnpm

.gitpod.dockerfile

@@ -0,0 +1,30 @@
+image:
+  file: .gitpod.dockerfile
+
+tasks:
+  - init: pnpm install
+    command: cd viewer && pnpm serve
+
+ports:
+  - port: 8080
+    onOpen: open-preview
+
+github:
+  prebuilds:
+    # enable for the master/default branch (defaults to true)
+    master: true
+    # enable for pull requests coming from this repo (defaults to true)
+    pullRequests: true
+    # enable for pull requests coming from forks (defaults to false)
+    pullRequestsFromForks: true
+    # add a "Review in Gitpod" button as a comment to pull requests (defaults to true)
+    addComment: true
+    # add a "Review in Gitpod" button to pull requests (defaults to false)
+    addBadge: false
+    # add a label once the prebuild is ready to pull requests (defaults to false)
+    addLabel: prebuilt-in-gitpod
+
+vscode:
+  extensions:
+    - [email protected]:03mwRhlVpWDul4qBChcVUA==
+    - [email protected]:iedq1JRjfM74CfhCoy3gJQ==

.gitpod.yml

@@ -0,0 +1 @@
+_

.husky/.gitignore

@@ -0,0 +1 @@
+shared-workspace-lockfile = false

.npmrc

@@ -0,0 +1,3 @@
+{
+  "tabWidth": 4
+}

.prettierrc

@@ -0,0 +1,29 @@
+# Container
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/boardgamers/container)
+
+Mono repo containing the viewer & the engine for Gaia Container
+
+Checkout their READMEs:
+
+- [engine](./engine/README.md)
+- [viewer](./viewer/README.md)
+
+## Demo
+
+Check out [boardgamers.space](https://www.boardgamers.space)! Reach out to us if you want to contribute.
+
+## Install
+
+Do `pnpm install` in the main folder
+
+## Test locally
+
+After the installation step, you can run the viewer with:
+
+```
+cd viewer
+npm run serve
+```
+
+It will use the engine in its sibling folder

README.md

@@ -1,44 +1,31 @@
-# gaia-engine
+# container-engine
 
 Typescript engine for Container.
 
 ## Setup
 
 ### Requirements
 
-Recent version of node / yarn.
+Recent version of node / pnpm.
 
 ### Dependencies
 
 In the project's folder:
 
 ```
-yarn
+pnpm
 ```
 
 ### Build
 
 To compile Typescript into javascript:
 
 ```
-yarn build
+pnpm build
 ```
 
 ### Test
 
 ```
-yarn test
-```
-
-### Usage as a dependency from another module
-
-If you want to use your local copy of this module instead of the npm version, as a dependency of
-another module, do this:
-
-```
-## In this folder
-yarn link
-
-## In the other project's folder
-yarn link container-engine
+pnpm test
 ```