https://github.com/clement-berard/micro-pad
A minimalist real-time collaborative notepad with built-in dark mode.
https://github.com/clement-berard/micro-pad
collaborative pad real-time
Last synced: 11 months ago
JSON representation
A minimalist real-time collaborative notepad with built-in dark mode.
- Host: GitHub
- URL: https://github.com/clement-berard/micro-pad
- Owner: clement-berard
- Created: 2024-12-14T12:07:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-21T10:26:50.000Z (12 months ago)
- Last Synced: 2025-06-21T10:28:13.060Z (12 months ago)
- Topics: collaborative, pad, real-time
- Language: TypeScript
- Homepage:
- Size: 131 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# micro-pad
A minimalist real-time collaborative notepad with built-in dark mode.
## 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
```bash
npm install -g micro-pad
```
## Usage
### Start the server
```bash
micro-pad
```
Server will start on port 3000 by default. (override by `env.PORT`)
### Access a pad
- Open http://localhost:3000 - redirects to a random pad
- Or directly access a specific pad: http://localhost:3000/my-custom-pad-name
## Docker
You can run micro-pad using Docker Compose:
```yaml
version: '3'
services:
pad:
image: node:22-alpine
command: sh -c "npx 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