https://github.com/fallenmax/notepad.cc

A notepad.cc cover using Koa/Socket.io
https://github.com/fallenmax/notepad.cc

Last synced: 2 months ago
JSON representation

A notepad.cc cover using Koa/Socket.io

• Host: GitHub
• URL: https://github.com/fallenmax/notepad.cc
• Owner: FallenMax
• Created: 2016-08-16T09:44:39.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-06-26T03:12:35.000Z (over 2 years ago)
• Last Synced: 2024-04-10T12:33:21.348Z (10 months ago)
• Language: TypeScript
• Homepage: http://notepad.1976f.com/
• Size: 704 KB
• Stars: 107
• Watchers: 11
• Forks: 30
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# A quick cover of notepad.cc

## Demo

https://notepad.1976f.com/

## Features

- (Original) _notepad.cc ([discontinued](https://www.reddit.com/r/UsefulWebsites/comments/3wepc4/notepadcc_online_notepad_is_shutting_down_soon/))_ style and features

  - No login/register required, user can start writing right away

  - Open/create notes using `pathname` part of url

  - Save as you type

- Extras

  - **Real-time collaboration**, implemented using [Socket.IO] and [diff3] algorithm.

  - **Better list editing UX**

    - Tab: indent list item(s)

    - Shift + Tab: deindent list item(s)

    - Enter: new list item

    - -: turn selected block into list

    - ...More to be discovered

## Requirements

- [mongodb](https://www.mongodb.com/)

## Getting Started

```shell

# make sure you have mongodb running and configured accordingly

export MONGODB_URL=your-mongodb-url

export MONGODB_DATABASE=mongdo-database-to-use

yarn

yarn start

```

[diff3]: https://en.wikipedia.org/wiki/Diff3

[socket.io]: https://socket.io/