Publish Code

.gitignore

@@ -0,0 +1,30 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+node_modules
+.pnp
+.pnp.js
+
+# testing
+coverage
+
+# production
+build
+
+# misc
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+.DS_Store
+*swp
+*swo
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+api-key.json
+
+server/output.log
+server/data/

README.md

@@ -0,0 +1,40 @@
+# RAMBLER (CHI 2023)
+
+### Supporting Writing With Speech via LLM-Assisted Gist Manipulation
+
+See our paper PDF: https://arxiv.org/abs/2401.10838
+
+
+### Installation
+
+For frontend (app):
+
+        cd app
+        npm install
+        npm run start
+
+...and for backend, in a new terminal (server):
+
+        cd server
+        npm install
+        node server.js
+
+
+### Secrets
+
+In the project's root directory (`rambler/`), create a new file named `.env`, and fill out the related API keys:
+
+```
+ASSEMBLYAI_API_KEY=
+OPENAI_API_KEY=
+LLM_KEY=
+```
+
+
+### Code formatting
+
+        npx prettier . --write
+
+Or in VS Code:
+
+        Format Document With... > Prettier - Code formatter

app/.prettierignore

@@ -0,0 +1,3 @@
+# Ignore artifacts:
+build
+coverage

app/.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": false
+}