1.0.3 • Published 10 months ago

micro-pad v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

micro-pad

A minimalist real-time collaborative notepad with built-in dark mode.

screenshot.jpg

Features

  • Real-time collaboration: Multiple users can edit the same pad simultaneously
  • Instant sync across all connected clients
  • Dark mode toggle
  • Fullscreen mode
  • Minimalist interface: Just write!
  • Random pad ID generation if none provided
  • No database required, everything runs in memory

Installation

npm install -g micro-pad

Usage

Start the server

micro-pad

Server will start on port 3000 by default.

Access a pad

Docker

You can run micro-pad using Docker Compose:

version: '3'

services:
  pad:
    image: node:20-alpine
    command: sh -c "npm i -g micro-pad && micro-pad"
    ports:
      - "3000:3000"

Technical Stack

  • Node.js 20+
  • Hono (web framework)
  • WebSocket for real-time communication
  • TypeScript
  • ESBuild for bundling

Notes

  • Pads are stored in memory and will be lost when the server restarts
  • No authentication or access control
  • No persistence layer

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT License

1.0.3

10 months ago

1.0.2

10 months ago

1.0.1

10 months ago