create-gardener 2.0.5 → 2.0.7

package/README.md

@@ -0,0 +1,187 @@
+# Gardener Web Application Template
+
+A modern full-stack web application template created with **create-gardener**. This project provides a production-ready setup with TypeScript, Express.js backend, EJS templating, and Tailwind CSS for styling.
+
+## 🚀 Features
+
+- **TypeScript Backend** - Type-safe Express.js server with modern ES modules
+- **EJS Templating** - Server-side rendering with EJS view engine
+- **Tailwind CSS** - Utility-first CSS framework with JIT compilation
+- **Hot Reload Development** - Live reload for both backend and frontend during development
+- **Production Ready** - Optimized build process with minification
+- **Testing Setup** - Jest configuration for unit and integration tests
+- **Image Processing** - Sharp integration for image optimization
+- **Validation** - Zod schema validation
+- **Environment Configuration** - dotenv support for environment variables
+
+## 📋 Prerequisites
+
+- Node.js (v18 or higher recommended)
+- pnpm (preferred) or npm
+
+## 🛠️ Installation
+
+```bash
+# Install dependencies
+pnpm install
+# or
+npm install
+```
+
+## 🏃 Getting Started
+
+### Development Mode
+
+Start the development server with hot reload:
+
+```bash
+pnpm dev
+# or
+npm run dev
+```
+
+This will:
+- Start the TypeScript backend server with watch mode on port 3000 (or PORT from .env)
+- Run Tailwind CSS in watch mode for live style updates
+
+### Production Build
+
+Build the application for production:
+
+```bash
+pnpm build
+# or
+npm run build
+```
+
+This will:
+1. Compile and minify Tailwind CSS
+2. Transpile TypeScript to JavaScript
+3. Copy frontend assets to the build directory
+4. Generate production configuration
+
+### Start Production Server
+
+```bash
+pnpm start
+# or
+npm start
+```
+
+Runs the compiled production build from the `build` directory.
+
+** Refer to docs.md for full docs **
+
+## 🧪 Testing
+
+Run tests with Jest:
+
+```bash
+pnpm test
+# or
+npm test
+```
+
+## 📁 Project Structure
+
+```
+.
+├── src/
+│   ├── backend/          # Backend TypeScript code
+│   │   ├── controllers/  # Route controllers
+│   │   ├── routes/       # Express routes
+│   │   ├── libs/         # Utility libraries
+│   │   └── server.ts     # Main server file
+│   └── frontend/         # Frontend assets
+│       ├── views/        # EJS templates
+│       ├── static/       # Static files (CSS, JS, images)
+│       ├── assets/       # Source assets
+│       ├── template/     # Frontend templates
+│       └── tailwind.css  # Tailwind source file
+├── build/                # Production build output
+├── buildHelper.js        # Build utility script
+├── jest.config.js        # Jest configuration
+├── tsconfig.json         # TypeScript configuration
+├── package.json          # Project dependencies
+└── .env                  # Environment variables
+```
+
+## ⚙️ Configuration
+
+### Environment Variables
+
+Create a `.env` file in the root directory:
+
+```env
+PORT=3000
+NODE_ENV=development
+```
+
+### TypeScript
+
+The project uses strict TypeScript configuration with:
+- ES modules (`"module": "nodenext"`)
+- Strict type checking
+- Source maps for debugging
+- Declaration files generation
+
+### Tailwind CSS
+
+Tailwind CSS v4 is configured with:
+- JIT (Just-In-Time) compilation
+- Minification in production builds
+- Custom styles in `src/frontend/tailwind.css`
+
+## 📦 Dependencies
+
+### Production
+- **express** - Fast, minimalist web framework
+- **ejs** - Embedded JavaScript templating
+- **tailwindcss** - Utility-first CSS framework
+- **sharp** - High-performance image processing
+- **zod** - TypeScript-first schema validation
+- **dotenv** - Environment variable management
+
+### Development
+- **typescript** - TypeScript compiler
+- **tsx** - TypeScript execution and REPL
+- **jest** - Testing framework
+- **concurrently** - Run multiple commands concurrently
+- **cross-env** - Cross-platform environment variables
+
+## 🔧 Build Process
+
+The `buildHelper.js` script handles:
+1. Copying frontend files to the build directory
+2. Generating production configuration (`gardenerConfig.js`)
+3. Cleaning up unnecessary template files
+
+## 📝 Scripts
+
+| Script | Description |
+|--------|-------------|
+| `pnpm dev` | Start development server with hot reload |
+| `pnpm build` | Build for production |
+| `pnpm start` | Start production server |
+| `pnpm test` | Run Jest tests |
+
+## 🤝 Contributing
+
+This is a template project created by create-gardener. Feel free to modify it according to your needs.
+
+## 📄 License
+
+MIT
+
+## 👤 Author
+
+ritishDas
+
+## 🔗 Links
+
+- [Gardener Homepage](https://gardener.ritish.site)
+- [GitHub Repository](https://github.com/ritishDas/gardener)
+
+---
+
+Created with [create-gardener](https://www.npmjs.com/package/create-gardener) 🌱

package/package.json

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

package/template/buildHelper.js

@@ -1,18 +1,19 @@
 import fs from 'fs/promises';
 import path from 'path';
 
-async function buildHelper() {
+export default async function buildHelper() {
   const src = path.resolve('src', 'frontend');
   const dest = path.resolve('build', 'frontend');
 
   await fs.cp(src, dest, { recursive: true });
 
-  await fs.writeFile(path.join(dest, 'static', 'gardenerConfig.js'), "export const
- mode = 'prod'; ", 'utf8');
+  await fs.writeFile(path.join(dest, 'static', 'gardenerConfig.js'), "export const mode = 'prod'; ", 'utf8');
 
   await fs.rm(path.join(dest, 'template'), { recursive: true });
 
 }
 
-buildHelper();
+if (import.meta.url === `file://${process.argv[1]}`) {
+  buildHelper();
+}
 

package/template/buildHelper.test.js

@@ -0,0 +1,78 @@
+import { jest } from '@jest/globals';
+import fs from 'fs/promises';
+import path from 'path';
+
+jest.mock('fs/promises');
+
+describe('buildHelper', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+
+    fs.cp = jest.fn().mockResolvedValue(undefined);
+    fs.writeFile = jest.fn().mockResolvedValue(undefined);
+    fs.rm = jest.fn().mockResolvedValue(undefined);
+  });
+
+  test('copies frontend directory', async () => {
+    const { default: buildHelper } = await import('./buildHelper.js');
+    await buildHelper();
+
+    expect(fs.cp).toHaveBeenCalledWith(
+      path.resolve('src', 'frontend'),
+      path.resolve('build', 'frontend'),
+      { recursive: true }
+    );
+  });
+
+  test('writes gardenerConfig.js', async () => {
+    const { default: buildHelper } = await import('./buildHelper.js');
+    await buildHelper();
+
+    expect(fs.writeFile).toHaveBeenCalledWith(
+      path.join(path.resolve('build', 'frontend'), 'static', 'gardenerConfig.js'),
+      "export const mode = 'prod'; ",
+      'utf8'
+    );
+  });
+
+  test('removes template directory', async () => {
+    const { default: buildHelper } = await import('./buildHelper.js');
+    await buildHelper();
+
+    expect(fs.rm).toHaveBeenCalledWith(
+      path.join(path.resolve('build', 'frontend'), 'template'),
+      { recursive: true }
+    );
+  });
+
+  test('runs operations in correct order', async () => {
+    const operations = [];
+
+    fs.cp.mockImplementation(async () => operations.push('cp'));
+    fs.writeFile.mockImplementation(async () => operations.push('writeFile'));
+    fs.rm.mockImplementation(async () => operations.push('rm'));
+
+    const { default: buildHelper } = await import('./buildHelper.js');
+    await buildHelper();
+
+    expect(operations).toEqual(['cp', 'writeFile', 'rm']);
+  });
+
+  test('fails early if copy fails', async () => {
+    fs.cp.mockRejectedValue(new Error('Copy failed'));
+
+    const { default: buildHelper } = await import('./buildHelper.js');
+
+    await expect(buildHelper()).rejects.toThrow('Copy failed');
+    expect(fs.writeFile).not.toHaveBeenCalled();
+  });
+
+  test('fails if write fails and skips rm', async () => {
+    fs.writeFile.mockRejectedValue(new Error('Write failed'));
+
+    const { default: buildHelper } = await import('./buildHelper.js');
+
+    await expect(buildHelper()).rejects.toThrow('Write failed');
+    expect(fs.rm).not.toHaveBeenCalled();
+  });
+});

package/template/jest.config.js

@@ -0,0 +1,13 @@
+export default {
+  testEnvironment: 'node',
+  transform: {},
+  testMatch: ['**/*.test.js'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  collectCoverageFrom: [
+    '*.js',
+    '!jest.config.js',
+    '!*.test.js',
+  ],
+};

package/template/package.json

@@ -7,7 +7,7 @@
     "start": "cross-env NODE_ENV=production node build/backend/server.js",
     "dev": "concurrently \"cross-env NODE_ENV=development tsx watch src/backend/server.ts\" \"tailwindcss -w -i src/frontend/tailwind.css -o src/frontend/static/style.css\"",
     "build": "tailwindcss -i src/frontend/tailwind.css -o src/frontend/static/style.css --minify && tsc && node buildHelper.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
   },
   "keywords": [],
   "author": "ritishDas",
@@ -21,11 +21,14 @@
     "zod": "^4.3.6"
   },
   "devDependencies": {
+    "@jest/globals": "^30.3.0",
     "@types/ejs": "^3.1.5",
     "@types/express": "^5.0.6",
     "@types/node": "^25.0.2",
     "concurrently": "^9.2.1",
     "cross-env": "^10.1.0",
+    "jest": "^30.3.0",
+    "jest-environment-jsdom": "^30.3.0",
     "tailwindcss": "^4.1.18",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3"