@kdrgny/justjson 1.0.0 → 1.0.1

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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +72 -0
  3. package/package.json +14 -3
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Kadir Günay
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,72 @@
1
+ <div align="center">
2
+
3
+ # JustJSON
4
+
5
+ **A tiny local-first CMS. Build your schema in a visual UI, edit content in a clean editor — everything stays on disk as plain JSON.**
6
+
7
+ No database · no account · no lock-in.
8
+
9
+ [Website](https://justjson-site.vercel.app) ·
10
+ [GitHub](https://github.com/kdrgny-dev/justjson) ·
11
+ MIT
12
+
13
+ </div>
14
+
15
+ ---
16
+
17
+ JustJSON is the cleanest way to manage structured content **without writing config**. Design collections and fields by clicking, fill them in a real editor, and get plain JSON files you own — in your own repo, ready for your build.
18
+
19
+ It runs entirely on your machine. Nothing is uploaded anywhere; your content is just files on disk.
20
+
21
+ ## Quick start
22
+
23
+ ```bash
24
+ cd my-project/
25
+ npx @kdrgny/justjson init # start from a template (blog, cv) — or scratch
26
+ npx @kdrgny/justjson # opens the editor in your browser
27
+ ```
28
+
29
+ Design your schema, enter content, upload images. Everything is written to `content/*.json` in your folder. Commit it, deploy it, import it in your build — your flow.
30
+
31
+ ## What you get
32
+
33
+ | | |
34
+ |---|---|
35
+ | **Visual schema builder** | Define collections and fields in the UI. Pick a field type from icon cards — no config file to hand-write. |
36
+ | **Searchable content table** | Entries listed by title, slug and date. Search and edit instantly — content, not a pile of slugs. |
37
+ | **Rich-text editor** | Headings, bold, lists, quotes — WYSIWYG, saved to disk as clean, diffable Markdown. |
38
+ | **Image uploads** | Drop an image; it's resized to WebP in the browser and written under `content/media/`. |
39
+ | **Type-safe output** | Generates `types.ts` from your schema, so your content is fully typed in your project. |
40
+ | **The endpoint is yours** | Wherever you put the JSON becomes your API — repo raw, jsDelivr, your build. Or export a ZIP. |
41
+
42
+ Field types: `text` · `richtext` · `number` · `boolean` · `date` · `select` · `relation` (multi) · `image`.
43
+
44
+ ## Commands
45
+
46
+ | Command | What it does |
47
+ |---|---|
48
+ | `npx @kdrgny/justjson` (or `serve`) | Starts the local editor and opens it in your browser |
49
+ | `npx @kdrgny/justjson init [template]` | Scaffolds a schema from a template (`blog`, `cv`) |
50
+ | `npx @kdrgny/justjson types` | Generates `types.ts` from your schema |
51
+ | `npx @kdrgny/justjson export` | Exports a ZIP snapshot (schema + content + types) |
52
+
53
+ ## How it works
54
+
55
+ Your project holds a `content/` folder. JustJSON reads and writes it — that's all.
56
+
57
+ ```
58
+ content/
59
+ _schema.json ← your schema (built from the UI)
60
+ posts/
61
+ hello-world.json ← one file per entry
62
+ settings.json ← singletons
63
+ media/ ← uploaded images (WebP)
64
+ ```
65
+
66
+ The editor is served locally by the CLI; it talks only to your disk. Delete `node_modules`, keep the JSON — your content is never trapped in a tool.
67
+
68
+ JustJSON is deliberately small. It does one thing — turn a schema into editable JSON content — and tries to do it well.
69
+
70
+ ## License
71
+
72
+ [MIT](https://github.com/kdrgny-dev/justjson/blob/main/LICENSE) © Kadir Günay
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kdrgny/justjson",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "A tiny local-first CMS — build your schema in a visual UI, edit content, keep everything as plain JSON on disk.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -14,11 +14,22 @@
14
14
  "url": "git+https://github.com/kdrgny-dev/justjson.git",
15
15
  "directory": "packages/justjson"
16
16
  },
17
- "keywords": ["cms", "json", "headless", "local", "content", "git", "static-site", "schema"],
17
+ "keywords": [
18
+ "cms",
19
+ "json",
20
+ "headless",
21
+ "local",
22
+ "content",
23
+ "git",
24
+ "static-site",
25
+ "schema"
26
+ ],
18
27
  "bin": {
19
28
  "justjson": "./dist/cli.js"
20
29
  },
21
- "files": ["dist"],
30
+ "files": [
31
+ "dist"
32
+ ],
22
33
  "scripts": {
23
34
  "build": "tsup && node scripts/bundle-editor.mjs",
24
35
  "dev": "tsup --watch",