https://github.com/renanlecaro/picnic

Minimalist real time collaborative text editor (to organise a picknick between friends for example)
https://github.com/renanlecaro/picnic

collaborative-editing nodejs plaintext vanilla-javascript websocket ws

Last synced: 3 months ago
JSON representation

Minimalist real time collaborative text editor (to organise a picknick between friends for example)

• Host: GitHub
• URL: https://github.com/renanlecaro/picnic
• Owner: renanlecaro
• License: mit
• Created: 2022-01-07T00:22:35.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-28T14:00:10.000Z (10 months ago)
• Last Synced: 2024-04-28T15:22:31.025Z (10 months ago)
• Topics: collaborative-editing, nodejs, plaintext, vanilla-javascript, websocket, ws
• Language: JavaScript
• Homepage: https://txt.lecaro.me
• Size: 396 KB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Picnic: privacy first collaborative text editor.

Picnic is a very generic app that tries to solve one specific problem :

You are organizing a picnic with friends and need to decide who brings

what.

You could spam the WhatsApp group with messages like "I'll bring

sandwiches" and "I'll bring drinks", but it quickly gets messy and

difficult to know who brings what and what is missing.

With picnic, you just create a document,

post the link in the group chat, and then edit it together.

The hosted version of this software is provided without any guarantee,

if you don't want your texts to disappear one day, I'd recommend setting

up your own instance.

## Development

Pull the source and install with `npm i` then start the

server on http://localhost:4444/ with `npm start`.

The project is auto-formatted by prettier on commit.

## Host your own

I'm using [meteor-up](http://meteor-up.com/) to deploy on my server with

the [mup node pluging](https://github.com/zodern/mup-node) but really you can

host this anywhere.

All you need is node on your server (I'm running v12.22.7 locally) and `npm i --production && npm run prod`. The data is saved in the ./data folder as json files (the actual text content is encrypted) so i'd recommend setting a volume on

that folder in Docker.

I think it could be tricky to host on heroku because the fs is ephemeral there.

I host mine on digitalocean.