Merge pull request talkjs#449 from talkjs/feat/add_remote_work_demo

(ex) added remote work demo example
shsaqib99 · Oct 19, 2023 · 3948cb5 · 3948cb5
2 parents 0065e53 + 145c6a6
commit 3948cb5
Show file tree

Hide file tree

Showing 15 changed files with 28,070 additions and 0 deletions.
diff --git a/react/remote-work-demo/.gitignore b/react/remote-work-demo/.gitignore
@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/react/remote-work-demo/README.md b/react/remote-work-demo/README.md
@@ -0,0 +1,18 @@
+## Intro
+This repo is basically a clone of our [remote work demo](https://talkjs.com/demo/team-chat/), set up as a standalone react app.
+
+## Instructions
+1. Clone the repo.
+
+2. Install dependencies by either running `npm install` or `yarn`.
+
+3. Create a TalkJS account.
+
+4. Grab your App ID, which you can find in your dashboard.
+
+5. In talkjsConfig.js, replace `appId` with your App ID.
+
+6. From this point on, you're ready to start up the app using using either `npm run` or `yarn start`. The app will be up and running at localhost:3000.
+
+The app is prepopulated with a default user and a couple of hardcoded conversations, which easily can be replaced with your own users and conversations. You can find these conversations and the default `userId` in `src/talkJsConfig.js` as well. 
+