create-gardener 1.1.7 → 1.1.8

package/Readme.md

@@ -16,322 +16,11 @@ Use it with
 `npm create-gardener filename`
 ---
 
-## What Gardener Includes
+[See Docs](https://ritish.site/Gardener)
+[Github](https://github.com/ritishDas/Gardener)
 
-### Core
 
-* 🌿 **gardener.js** — declarative DOM builder using JSON objects
-* 🔁 **parser** — convert real DOM elements back into gardener-compatible JSON
-* 📄 **EJS** for simple server-rendered views
-* 🎨 **Tailwind CSS** for fast styling
 
-### Dev Server
-
-* Express-based development server
-* Hot reload toggle (Ctrl + H)
-* Endpoints to create pages and components at runtime (dev convenience)
-
-### Images
-
-* Deterministic image optimization endpoint
-* Sharp-powered resize + WebP conversion
-* Filesystem cache reused during static builds
-
-### Static Site Generation (SSG)
-
-* Render EJS views into HTML
-* Convert route-encoded filenames into nested directories
-* Merge frontend assets and image cache
-* Clean temporary build artifacts
-* Produce a deployable static directory
-
----
-
-## Project Structure
-
-```
-src/
-├── backend/
-│   ├── routes/
-│   ├── controllers/
-│   ├── libs/
-│   ├── cache/              # generated image cache (build artifact)
-│   └── server.ts
-│
-├── frontend/
-│   ├── views/              # EJS templates (source)
-│   ├── assets/             # original images
-│   ├── components/
-│   ├── gardener.js
-│   ├── styles/
-│   └── frontendtemplate.ejs    #starter file to create new page
-│
-│
-│
-├── frontendStatic/          # final static output (generated)
-└── tempfrontend/            # temporary build output (deleted after build)
-```
-
----
-
-## Requirements
-
-* Node.js v16+ (v18+ recommended)
-* pnpm (recommended) or npm
-* Optional: PostgreSQL
-
----
-
-## Quickstart (Development)
-
-### 1. Install
-
-```bash
-git clone https://github.com/ritishDas/Gardener.git
-cd Gardener
-pnpm install
-```
-
-### 2. Run dev server
-
-```bash
-pnpm run dev
-```
-
-* Server runs at **[http://localhost:3000](http://localhost:3000)**
-* Tailwind watcher and TypeScript server run together
-
----
-
-## Image Optimization & Caching
-
-Gardener provides a **deterministic image optimization endpoint**.
-put your images in ./src/frontend/assets and use /cache/[imagename]_[width]x[height].webp in img tag.
-
-
-### Filename format
-
-```
-<basename>_<width>x<height>.webp
-```
-
-### Example
-
-```http
-GET /cache/hero_500x300.webp
-```
-
-HTML usage:
-
-```html
-<img src="/cache/hero_500x300.webp" alt="hero" />
-```
-
----
-
-### How it works
-
-1. Parses filename to extract:
-
-   * base name
-   * width
-   * height
-2. Checks cache:
-
-   ```
-   src/backend/cache/
-   ```
-3. If cached → return immediately
-4. If not cached:
-
-   * Finds source image in:
-
-     ```
-     src/frontend/assets/
-     ```
-   * Resizes and converts to WebP (Sharp)
-   * Stores result in cache
-5. Serves the optimized image
-
----
-
-### Static Build Integration
-
-During static generation:
-
-* All cached images under:
-
-  ```
-  src/backend/cache/
-  ```
-
-  are copied into:
-
-  ```
-  src/frontendStatic/
-  ```
-
-Static HTML can safely reference:
-
-```html
-<img src="/cache/hero_500x300.webp" />
-```
-
-No runtime image processing is required in production.
-
----
-
-## Static Site Generation
-
-Gardener includes a custom static build pipeline.
-
-### What it does
-
-1. Renders EJS views into HTML
-2. Writes temporary files using route-encoded filenames
-   (example: `_blog_posts_hello.html`)
-3. Converts them into directory-based routes:
-
-   ```
-   blog/posts/hello/index.html
-   ```
-4. Copies frontend assets
-5. Copies image cache
-6. Deletes temporary build directory
-
-### Output
-
-```
-src/frontendStatic/
-├── index.html
-├── blog/
-│   └── posts/
-│       └── hello/
-│           └── index.html
-├── assets/
-└── cache/
-```
-
-This directory is ready for:
-
-* static hosting
-* CDN deployment
-* Nginx / Caddy / Netlify / Vercel
-
----
-
-## Frontend API — `gardener.js`
-
-File: `src/frontend/gardener.js`
-
-### `gardener(obj)`
-
-Create DOM elements from JSON.
-
-```js
-const el = gardener({
-  t: 'div',
-  cn: ['card', 'p-4'],
-  children: [
-    { t: 'h2', txt: 'Title' },
-    { t: 'p', txt: 'Content' }
-  ]
-});
-
-document.body.appendChild(el);
-```
-
----
-
-### `parser(elementOrHtml, isParent = true)`
-
-Convert DOM into gardener JSON.
-
-```js
-const json = parser(document.querySelector('.hero'));
-console.log(json);
-```
-
----
-
-### `parserWindow(text)`
-
-Dev-only UI:
-
-* Preview parsed JSON
-* Press **Y** to create a component file
-
----
-
-### Utilities
-
-* `imagePreloader(images)`
-* `fetchElement(selector)`
-* `appendElement(parent, child)`
-* `replaceElement(original, newElem)`
-* `createElement(type, classname)`
-
----
-
-## Dev-Only Endpoints ⚠️
-
-### `POST /addcomponent`
-
-Creates a frontend component file.
-
-```json
-{
-  "path": "components/MyComp.js",
-  "component": "{ t: 'div', txt: 'Hello' }"
-}
-```
-
-Writes directly to the filesystem.
-
----
-
-### `POST /addpage`
-
-Creates an EJS page and registers a route.
-
-```json
-{ "page": "/my-page" }
-```
-
-* Generates a new EJS file
-* Appends a route to the backend router
-
----
-
-## Security Notes
-
-⚠️ **Important**
-
-* Gardener doesn't support <span>hi<span>rohan</span></span> use <span><span>hi</span><span>rohan</span></span> basically text node elements shouldn't have siblings.
-* `/addcomponent` and `/addpage` mutate files and routes
-* Intended for **local development only**
-* Do NOT expose publicly without authentication and sanitization
-
----
-
-## Troubleshooting
-
-* **Server not starting**
-
-  * Check `.env`
-  * Ensure PostgreSQL is running (if enabled)
-  * Inspect logs from `pnpm run dev`
-
-* **Images not loading**
-
-  * Ensure source image exists in `src/frontend/assets`
-  * Filename must match `<name>_<width>x<height>.webp`
-
-* **Tailwind not updating**
-
-  * Ensure `pnpm install` completed successfully
-
----
 
 ## Contributing
 

package/package.json

@@ -5,7 +5,7 @@
     "type": "git",
     "url": "https://github.com/ritishDas/gardener"
   },
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "A dom gardener converting dom elements into json and vice versa",
   "main": "index.js",
   "bin": {

package/template/package.json

@@ -1,35 +1,34 @@
 {
   "name": "create-gardener",
-  "version": "1.1.4",
+  "version": "1.1.8",
   "description": "A dom gardener converting dom elements into json and vice versa",
-  "main": "index.js",
-  "bin": {
-    "create-gardener": "./starter.js"
-  },
+  "main": "src/build/server.js",
   "type": "module",
   "scripts": {
+    "start": "node src/build/server.js",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "dev": "concurrently \"tsx watch src/backend/server.ts\" \"tailwindcss -w -i src/frontend/tailwind.css -o src/frontend/style.css\""
+    "dev": "concurrently \"tsx watch src/backend/server.ts\" \"tailwindcss -w -i src/frontend/tailwind.css -o src/frontend/style.css\"",
+ "build": "tsc"
   },
   "keywords": [],
   "author": "ritishDas",
   "license": "MIT",
-  "packageManager": "pnpm@10.20.0",
   "dependencies": {
-    "@types/ejs": "^3.1.5",
     "dotenv": "^17.2.3",
     "ejs": "^3.1.10",
     "express": "^5.2.1",
     "sharp": "^0.34.5",
-    "tailwindcss": "^4.1.18",
     "types": "^0.1.1",
     "zod": "^4.3.6"
   },
   "devDependencies": {
+    "tailwindcss": "^4.1.18",
+    "tsx": "^4.21.0",
+    "@types/ejs": "^3.1.5",
     "@types/express": "^5.0.6",
     "@types/node": "^25.0.2",
-    "concurrently": "^9.2.1",
-    "tsx": "^4.21.0",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "concurrently": "^9.2.1"
   }
 }
+