bar

.github/workflows/rust.yml

@@ -0,0 +1,18 @@
+name: CI
+
+on: [push, pull_request]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Build
+      run: cargo build --verbose
+    - name: Run tests
+      run: cargo test --verbose

.gitignore

@@ -1 +1,3 @@
 /target
+render.out
+node_modules

.nvmrc

@@ -0,0 +1 @@
+20

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.formatOnSave": true
+}

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing
+
+This is a rust project, but you can contribute as a rust developer as much as a JavaScript developer.
+
+## Rust
+
+You will find your way in the the source code: [`./src`](./src/).
+
+To build the project:
+
+```sh
+cargo build
+```
+
+To run:
+
+```sh
+./target/debug/snakepipe # will show the help - you can use it is explained in the README
+```
+
+## JavaScript
+
+The [`snakepipe render-browser`](./README.md#-you-can-mirror-your-playing-terminal-into-another-one-through-http) command launches a rust http server that serves some JavaScript code that connects to server-sent-events and renders the game inside the browser.
+
+The source code for the renderers is available at [`static/renderers`](static/renderers).
+
+**You don't need rust to work on this part**. I made a nodejs development server that acts as the `snakepipe render-browser` command (that way, you also don't have to re-build the rust part each time you modify the frontend).
+
+### Install
+
+```sh
+npm install
+```
+
+### Setup
+
+Build the packages and retrieve a recorded party.
+
+```sh
+npm run build && npm run setup
+```
+
+### Run
+
+```sh
+npm run dev-server-sse
+```
+
+Go to [http://localhost:8080](http://localhost:8080).