https://github.com/tigerabrodi/remix-sockets-google-docs-simple

Simple google docs thing in Remix using socket.io.
https://github.com/tigerabrodi/remix-sockets-google-docs-simple

Last synced: 18 days ago
JSON representation

Simple google docs thing in Remix using socket.io.

• Host: GitHub
• URL: https://github.com/tigerabrodi/remix-sockets-google-docs-simple
• Owner: tigerabrodi
• Created: 2022-01-12T08:40:19.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-18T17:05:28.000Z (about 3 years ago)
• Last Synced: 2024-11-14T10:37:32.977Z (2 months ago)
• Language: TypeScript
• Homepage: https://remix-sockets.herokuapp.com/
• Size: 277 KB
• Stars: 20
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-remix - About Simple google docs thing in Remix using socket.io
• awesome-remix - About Simple google docs thing in Remix using socket.io

README

        
This is just a simple google docs thing, me playing around with Remix and sockets.

TODO: from socket.io to yjs sockets, support CRDT.

# Installation

After forking and cloning, run `npm install`, then you need two environment variables:

- `BASE_URL_DEV`: set to `http://localhost:3000/`

- `PORT`: set to `3000`

## Development

You'll need to run two terminals (or bring in a process manager like concurrently/pm2-dev if you like):

Start the Remix development asset server

```sh

npm run dev

```

In a new tab start your express app:

```sh

npm run start:dev

```

This starts your app in development mode, which will purge the server require cache when Remix rebuilds assets so you don't need a process manager restarting the express server.

# Tests

To run the tests: `npm run test`.

# Demo

https://user-images.githubusercontent.com/49603590/149983975-0139acfb-689b-4f23-8a59-447a3f145d81.mp4