Added devcontainer including documentation (#131)

* Added devcontainer * Documented devcontainer Co-authored-by: Cirrus CI <[email protected]>
ueman · Oct 29, 2021 · 803c46e · 803c46e
1 parent cdbe71a
commit 803c46e
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -0,0 +1,4 @@
+{
+    "image": "cirrusci/flutter:latest",
+    "forwardPorts": [3000]
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# Contributing
+
+## Via GitHub Codespaces
+
+The easiest way to get started contributing to this project is [by creating a new codespace](https://docs.github.com/en/codespaces/getting-started/quickstart#creating-your-codespace).
+
+After your codespace is ready, open a new integrated terminal and go to the example project:
+
+```
+cd ./feedback/example
+```
+
+Then download all dependencies and start the flutter web server:
+
+```
+flutter run -d web-server --web-hostname=0.0.0.0 --web-port=3000
+```
+
+> **Note:** A popup will show up in the lower right corner notifying you that your application is ready and running on port 3000. **The "Open in browser" link will only work _after_ the compilation has succeeded!** 
+> 
+> When you see an error page, wait until the compilation succeeds and refresh the browser tab. Otherwise you may need to go to the "PORTS" menu next to the VS Code terminal and click on the little browser icon that appears next to the local address when you hover over the entry for port 3000.
+
+Changes in the library or the example applications are reflected after hot restarting and reloading the browser tab.