sketchboard-app 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# SketchBoard
|
|
2
|
+
|
|
3
|
+
A local-first whiteboard app. Run instantly with no setup required.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx sketchboard-app
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
That's it. Your browser will open automatically at `http://localhost:4321`.
|
|
12
|
+
|
|
13
|
+
## Features
|
|
14
|
+
|
|
15
|
+
- **Zero setup** — no database, no config, no accounts needed
|
|
16
|
+
- **Local-first** — all data stored on your machine in `~/.sketchboard`
|
|
17
|
+
- **Offline capable** — works without internet once loaded
|
|
18
|
+
- **Collaboration** — share drawings with others on the same network
|
|
19
|
+
- **Export** — save your work as PNG, SVG, or JSON
|
|
20
|
+
|
|
21
|
+
## Data Storage
|
|
22
|
+
|
|
23
|
+
All drawings are saved locally at:
|
|
24
|
+
|
|
25
|
+
| OS | Path |
|
|
26
|
+
|---|---|
|
|
27
|
+
| Windows | `C:\Users\<you>\.sketchboard` |
|
|
28
|
+
| macOS | `/Users/<you>/.sketchboard` |
|
|
29
|
+
| Linux | `/home/<you>/.sketchboard` |
|
|
30
|
+
|
|
31
|
+
## Configuration
|
|
32
|
+
|
|
33
|
+
| Env Variable | Default | Description |
|
|
34
|
+
|---|---|---|
|
|
35
|
+
| `PORT` | `4321` | Server port |
|
|
36
|
+
| `SKETCHBOARD_DATA` | `~/.sketchboard` | Data directory |
|
|
37
|
+
|
|
38
|
+
Example:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
PORT=5678 npx sketchboard-app
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sketchboard-app",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "SketchBoard — local-first whiteboard app. Run with: npx sketchboard-app",
|
|
5
5
|
"main": "server.js",
|
|
6
6
|
"bin": {
|
|
7
|
-
"sketchboard": "
|
|
7
|
+
"sketchboard": "bin/sketchboard.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
10
|
"bin/",
|