create-berna-stencil 1.0.52 → 1.0.54

package/.eleventy.js

@@ -4,12 +4,13 @@ const Image = require("@11ty/eleventy-img");
 const fs = require("fs");
 const path = require("path");
 
-const OUTPUT_DIR = "out";
+const OUTPUT_DIR = "c:/laragon/www/Berna-Stencil-out";
 
 module.exports = function (eleventyConfig) {
 
   function copyRecursiveSync(src, dest) {
   if (!fs.existsSync(src)) return;
+  if (src.includes('.git')) return;
   const stat = fs.statSync(src);
   if (stat.isDirectory()) {
     fs.mkdirSync(dest, { recursive: true });

package/README.md

@@ -1,5 +1,16 @@
 # 🏗️ Berna-Stencil
-A professional boilerplate for Eleventy, lightweight and structure-focused, ready to scale.
+**Berna-Stencil** is an open source static site generator built on top of [Eleventy](https://www.11ty.dev/), designed with one clear mission: make web development simple, approachable, and enjoyable — for everyone.
+
+Whether you're a seasoned developer looking for a clean starting point or a beginner taking your first steps into the world of web creation, Berna-Stencil gives you everything you need, right out of the box. No complicated setup, no hours spent reading documentation, no frustration — just a solid, well-structured foundation ready to become your next website.
+
+### ✨ Why Berna-Stencil?
+
+Building a website from scratch involves a lot of moving parts: templating engines, build pipelines, asset management, backend logic, project structure. Berna-Stencil takes care of all of that for you, so you can focus on what actually matters — **your content and your ideas**.
+
+- 🔧 **Zero-config ready** — clone, install, and you're live in minutes
+- 🔗 **Integrated backend** — essential server-side functionality included, no extra setup required
+- 📁 **Scalable structure** — a clean, opinionated project layout that grows with your needs
+- 🌍 **Open source** — free to use, free to modify, free to share
 
 ![Version](https://img.shields.io/badge/version-1.0.0-blue)
 ![License](https://img.shields.io/badge/license-MIT-green)
@@ -7,15 +18,20 @@ A professional boilerplate for Eleventy, lightweight and structure-focused, read
 
 ## Prerequisites
 * **Node.js**: v18.0.0 or higher
+* **Composer**: latest stable version
 
 ## Installation
 * Open your IDE (e.g. Visual Studio Code), open the folder that contains your websites and open a new terminal
 * Run the command for your system to download the project and install everything:
-   #### Windows
    ```bash
    npm create berna-stencil@latest your-project
    ```
 
+* Navigate into the project folder
+   ```bash
+   cd your-project
+   ```
+
 * Install all the node_modules
    ```bash
    npm install
@@ -24,4 +40,17 @@ A professional boilerplate for Eleventy, lightweight and structure-focused, read
 * Run the command to launch the live server and build the site, then visit localhost:8080:
    ```bash
    npm run serve
-   ```
+   ```
+
+## Changelog
+
+### [1.0.0] - 2025-05-27
+* Initial release
+* Eleventy v3.1.2 support
+* Base project structure and scaffolding CLI
+
+## Roadmap
+* [ ] Add support for multiple themes
+* [ ] Improve CLI with interactive prompts
+* [ ] Add TypeScript support
+* [ ] Extend documentation with advanced usage examples

package/docs/Assistant CLI.md

@@ -1 +1,59 @@
-# ...
+# Assistant CLI
+
+An interactive CLI to manage pages without touching files manually.
+
+```
+npm run assistant
+```
+
+## Menu
+
+```
+1. Create page
+2. Remove page
+3. Rename page
+4. Configure output path
+```
+
+Use `CTRL/CMD + C` to exit.
+
+## Create page
+
+Enter a page name in any format — the CLI converts it to kebab-case automatically.
+
+For a page named `my-page`, the following files are created:
+
+| File | Purpose |
+|---|---|
+| `src/frontend/scss/pages/myPage.scss` | SCSS entry point |
+| `src/frontend/js/pages/myPage.js` | JS entry point |
+| `src/frontend/_routes/my-page.njk` | Nunjucks template |
+
+It also adds an `elif` block in `includes.njk` and a stub entry in `site.json`:
+
+```json
+"myPage": {
+  "seo": {
+    "title": "My Page",
+    "description": "description"
+  },
+  "cdn": {
+    "css": [],
+    "js": []
+  }
+}
+```
+
+## Remove page
+
+Deletes all source files for the page and cleans up the output directory, `includes.njk`, and `site.json`.
+
+## Rename page
+
+Renames all three source files, updates the `elif` block in `includes.njk`, and renames the record in `site.json` while preserving all existing fields.
+
+## Configure output path
+
+Updates the output directory across `.eleventy.js` and all relevant `package.json` scripts in one shot. The old output folder is deleted automatically.
+
+> ⚠️ `homepage` and `404` are protected — they cannot be created, removed, or renamed via the CLI.

package/docs/Backend.md

@@ -1 +1,210 @@
-# ...
+# Backend
+
+The backend is a PHP REST API located in `src/backend/`, copied to the output directory automatically at build time.
+
+## Structure
+
+```
+src/backend/
+├── api/
+│   ├── public/       # Endpoints accessible without an API key
+│   └── protected/    # Endpoints requiring X-Api-Key header
+├── database/
+│   ├── Database.php
+│   ├── models/
+│   └── migrations/
+├── config.php        # Your local config — never commit this
+└── config.example.php
+```
+
+## Configuration
+
+`config.php` works like a `.env` file — it holds secrets and environment settings that stay local and out of version control.
+
+Copy `config.example.php` to `config.php` and fill in your values:
+
+### config.php <small>(`src/backend/`)</small>
+```php
+return [
+    'APP_ENV' => 'development', // or 'production'
+    'API_KEY' => 'your-default-key',
+
+    'ENDPOINT_KEYS' => [
+        'subfolder/example-protected' => 'specific-key',
+    ],
+
+    'DB_HOST' => '127.0.0.1',
+    'DB_NAME' => 'example_db',
+    'DB_USER' => 'root',
+    'DB_PASS' => '',
+];
+```
+
+`API_KEY` is the fallback key for all protected endpoints. Use `ENDPOINT_KEYS` to assign a different key to a specific endpoint — for subfolder endpoints, use the relative path as the key.
+
+## How routing works
+
+The file path inside `api/` maps directly to the URL. Extra URL segments become route parameters available as `$requestParams[]`.
+
+Every endpoint file has access to:
+
+| Variable | Description |
+|---|---|
+| `$method` | HTTP method (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`) |
+| `$requestParams` | Extra URL segments (e.g. `/api/posts/42` → `['42']`) |
+
+## Creating a public endpoint
+
+Create a `.php` file anywhere inside `api/public/`
+
+### api/public/posts.php
+```php
+<?php
+declare(strict_types=1);
+
+require_once CORE_PATH . '/modules/Response.php';
+
+if ($method !== 'GET') {
+    Response::error('Method not allowed', 405);
+}
+
+$id = isset($requestParams[0]) ? (int)$requestParams[0] : null;
+
+Response::success(['id' => $id]);
+```
+
+Reachable at `/api/posts` or `/api/posts/42`
+
+## Creating a protected endpoint
+
+Create a `.php` file inside `api/protected/`. The API key check happens automatically before your file runs.
+
+### api/protected/admin/stats.php
+```php
+<?php
+declare(strict_types=1);
+
+require_once CORE_PATH . '/modules/Response.php';
+
+if ($method !== 'GET') {
+    Response::error('Method not allowed', 405);
+}
+
+Response::success(['visits' => 1024]);
+```
+
+To assign a dedicated key, add it to `config.php`:
+
+```php
+'ENDPOINT_KEYS' => [
+    'admin/stats' => 'secret-stats-key',
+],
+```
+
+## The Response helper
+
+```php
+Response::success($data, $code);          // default 200
+Response::error($message, $code, $details); // default 400
+Response::noContent();                    // 204
+```
+
+## Handling multiple methods
+
+```php
+$id    = isset($requestParams[0]) ? (int)$requestParams[0] : null;
+$input = json_decode(file_get_contents('php://input'), true) ?? [];
+
+switch ($method) {
+    case 'GET':
+        Response::success(['id' => $id]);
+        break;
+
+    case 'POST':
+        if (empty($input['title'])) Response::error('Missing title', 400);
+        Response::success(['message' => 'Created'], 201);
+        break;
+
+    case 'DELETE':
+        if (!$id) Response::error('ID required', 400);
+        Response::success(['message' => 'Deleted']);
+        break;
+
+    default:
+        Response::error('Method not allowed', 405);
+}
+```
+
+## Using the database
+
+### database/models/Post.php
+```php
+<?php
+declare(strict_types=1);
+
+require_once __DIR__ . '/../Database.php';
+
+class Post {
+    private PDO $db;
+
+    public function __construct() {
+        $this->db = Database::getInstance();
+    }
+
+    public function getAll(): array {
+        return $this->db->query("SELECT * FROM posts")->fetchAll();
+    }
+
+    public function getById(int $id): ?array {
+        $stmt = $this->db->prepare("SELECT * FROM posts WHERE id = :id");
+        $stmt->execute(['id' => $id]);
+        return $stmt->fetch() ?: null;
+    }
+
+    public function create(string $title): int {
+        $stmt = $this->db->prepare("INSERT INTO posts (title) VALUES (:title)");
+        $stmt->execute(['title' => htmlspecialchars(strip_tags(trim($title)))]);
+        return (int)$this->db->lastInsertId();
+    }
+}
+```
+
+Then use it inside an endpoint:
+
+```php
+require_once __DIR__ . '/../../database/models/Post.php';
+
+$post = new Post();
+Response::success($post->getAll());
+```
+
+Migrations live in `database/migrations/` as plain SQL files — run them manually against your database.
+
+## Calling endpoints from the frontend
+
+```js
+// Public
+const res = await fetch('/api/posts/42');
+
+// Protected
+const res = await fetch('/api/admin/stats', {
+    headers: { 'X-Api-Key': 'secret-stats-key' }
+});
+
+// POST
+const res = await fetch('/api/posts', {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', 'X-Api-Key': 'your-key' },
+    body: JSON.stringify({ title: 'Hello world' })
+});
+```
+
+## Pre-built endpoints
+
+| Route | Auth | Methods | Description |
+|---|---|---|---|
+| `/api/example-public` | No | `GET` | Smoke test for public routing |
+| `/api/subfolder/example-protected` | Yes | `GET` | Smoke test for protected routing |
+| `/api/auth/register` | No | `POST` | Register a new user |
+| `/api/auth/login` | No | `POST` | Login and retrieve user data |
+| `/api/auth-system` | Yes | `GET POST PUT PATCH DELETE` | Full CRUD on users |

package/docs/Styling with SCSS.md

@@ -28,6 +28,58 @@ body {
 }
 ```
 
+## Global Variables
+
+Instead of using `:root` in your custom modules or pages, the best thing to do is to centralize all your variables in a single file (that will be tree-shaken automatically by Sass)
+
+### _root.scss <small>(`src/frontend/scss/modules/`)</small>
+```scss
+$header-height: 10vh;
+
+// Usage example (in any other file): 
+header {
+  height: root.$header-height;
+}
+```
+## Scss modules
+You can create your custom css modules by creating a new `.scss` file in `src/frontend/scss/modules/` (the name of the file must start with `_`)
+
+You can create subfolders if you want to refactor the structure, but be sure to update the relative paths in the pages that import them
+
+### _yourModule.scss <small>(`src/frontend/scss/modules/subfolder/`)</small>
+```scss
+@use '../root' as root;
+
+body {
+  background-color: root.$primary;
+}
+```
+
+### examplePage.scss
+```scss
+@import "../modules/subfolder/yourModule";
+
+// This page will now inherit the body tag rules
+// If the same property is declared in both, the last imported one wins
+body {
+  color: root.$dark;
+}
+```
+
+### Pre-existing modules
+
+| File | Purpose |
+|---|---|
+| `_root.scss` | Global variables (colors, spacing) |
+| `_global.scss` | Site-wide base rules and frameworks |
+| `_typography.scss` | Font rules
+| `_header.scss` | Header styles |
+| `_footer.scss` | Footer styles |
+| `_mobile.scss` | Media query rules |
+| `_buttons.scss` | Style and hovers for buttons 
+| `_animations.scss` | Keyframe animations (`fade-in`, `spin`) |
+| `_notification.scss` | Notification component style |
+
 ## CSS Framework
 
 Some of the most popular css frameworks that supports scss with modules are already installed in `node_modules`
@@ -85,56 +137,4 @@ To reduce the bundle size, open the corresponding framework file (`src/frontend/
 ```scss
 @import "bootstrap/scss/card"; // Cards
 @import "bootstrap/scss/carousel"; // Carousel
-```
-
-## Global Variables
-
-Instead of using `:root` in your custom modules or pages, the best thing to do is to centralize all your variables in a single file (that will be tree-shaken automatically by Sass)
-
-### _root.scss <small>(`src/frontend/scss/modules/`)</small>
-```scss
-$header-height: 10vh;
-
-// Usage example (in any other file): 
-header {
-  height: root.$header-height;
-}
-```
-## Scss modules
-You can create your custom css modules by creating a new `.scss` file in `src/frontend/scss/modules/` (the name of the file must start with `_`)
-
-You can create subfolders if you want to refactor the structure, but be sure to update the relative paths in the pages that import them
-
-### _yourModule.scss <small>(`src/frontend/scss/modules/subfolder/`)</small>
-```scss
-@use '../root' as root;
-
-body {
-  background-color: root.$primary;
-}
-```
-
-### examplePage.scss
-```scss
-@import "../modules/subfolder/yourModule";
-
-// This page will now inherit the body tag rules
-// If the same property is declared in both, the last imported one wins
-body {
-  color: root.$dark;
-}
-```
-
-### Pre-existing modules
-
-| File | Purpose |
-|---|---|
-| `_root.scss` | Global variables (colors, spacing) |
-| `_global.scss` | Site-wide base rules and frameworks |
-| `_typography.scss` | Font rules
-| `_header.scss` | Header styles |
-| `_footer.scss` | Footer styles |
-| `_mobile.scss` | Media query rules |
-| `_buttons.scss` | Style and hovers for buttons 
-| `_animations.scss` | Keyframe animations (`fade-in`, `spin`) |
-| `_notification.scss` | Notification component style |
+```

package/package.json

@@ -1,59 +1,59 @@
-{
-  "name": "create-berna-stencil",
-  "version": "1.0.52",
-  "description": "Eleventy boilerplate with per-page SCSS/JS pipeline, esbuild bundling, multi-framework CSS support and a built-in page management CLI",
-  "keywords": [],
-  "author": "Michele Garofalo",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/rhaastrake/berna-stencil"
-  },
-  "homepage": "https://github.com/rhaastrake/berna-stencil#readme",
-  "bugs": {
-    "url": "https://github.com/rhaastrake/berna-stencil/issues"
-  },
-  "bin": {
-    "create-berna-stencil": "bin/create.js"
-  },
-  "files": [
-    "bin/",
-    "docs/",
-    "src/",
-    "_tools/",
-    ".eleventy.js",
-    ".eleventyignore",
-    ".gitignore"
-  ],
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "dependencies": {
-    "@11ty/eleventy": "^3.1.2",
-    "@11ty/eleventy-img": "^6.0.4",
-    "bootstrap": "^5.3.8",
-    "bootstrap-icons": "^1.13.1",
-    "bulma": "^1.0.4",
-    "foundation-sites": "^6.9.0",
-    "glob": "^13.0.6",
-    "uikit": "^3.25.13"
-  },
-  "devDependencies": {
-    "concurrently": "^9.2.1",
-    "esbuild": "^0.27.3",
-    "sass": "^1.77.0"
-  },
-  "scripts": {
-    "build:css": "sass src/frontend/scss:out/css --no-source-map --style=compressed --quiet",
-    "build:js": "esbuild \"src/frontend/js/pages/*.js\" --bundle --outdir=out/js/pages --minify",
-    "build:11ty": "eleventy",
-    "build": "npm run clean && npm run build:css && npm run build:js && npm run build:11ty",
-    "serve:css": "sass --watch src/frontend/scss:out/css --no-source-map --quiet",
-    "serve:js": "esbuild \"src/frontend/js/pages/*.js\" --bundle --outdir=out/js/pages --watch",
-    "serve:11ty": "eleventy --serve --quiet",
-    "clean": "node _tools/cleanOutput.js",
-    "serve": "npm run clean && concurrently \"npm run serve:11ty\" \"npm run serve:css\" \"npm run serve:js\"",
-    "assistant": "node _tools/assistant.js",
-    "postinstall": "cd src/backend/_core && composer install --quiet"
-  }
+{
+  "name": "create-berna-stencil",
+  "version": "1.0.54",
+  "description": "Eleventy boilerplate with per-page SCSS/JS pipeline, esbuild bundling, multi-framework CSS support and a built-in page management CLI",
+  "keywords": [],
+  "author": "Michele Garofalo",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rhaastrake/berna-stencil"
+  },
+  "homepage": "https://github.com/rhaastrake/berna-stencil#readme",
+  "bugs": {
+    "url": "https://github.com/rhaastrake/berna-stencil/issues"
+  },
+  "bin": {
+    "create-berna-stencil": "bin/create.js"
+  },
+  "files": [
+    "bin/",
+    "docs/",
+    "src/",
+    "_tools/",
+    ".eleventy.js",
+    ".eleventyignore",
+    ".gitignore"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@11ty/eleventy": "^3.1.2",
+    "@11ty/eleventy-img": "^6.0.4",
+    "bootstrap": "^5.3.8",
+    "bootstrap-icons": "^1.13.1",
+    "bulma": "^1.0.4",
+    "foundation-sites": "^6.9.0",
+    "glob": "^13.0.6",
+    "uikit": "^3.25.13"
+  },
+  "devDependencies": {
+    "concurrently": "^9.2.1",
+    "esbuild": "^0.27.3",
+    "sass": "^1.77.0"
+  },
+  "scripts": {
+    "build:css": "sass src/frontend/scss:c:/laragon/www/Berna-Stencil-out/css --no-source-map --style=compressed --quiet",
+    "build:js": "esbuild \"src/frontend/js/pages/*.js\" --bundle --outdir=c:/laragon/www/Berna-Stencil-out/js/pages --minify",
+    "build:11ty": "eleventy",
+    "build": "npm run clean && npm run build:css && npm run build:js && npm run build:11ty",
+    "serve:css": "sass --watch src/frontend/scss:c:/laragon/www/Berna-Stencil-out/css --no-source-map --quiet",
+    "serve:js": "esbuild \"src/frontend/js/pages/*.js\" --bundle --outdir=c:/laragon/www/Berna-Stencil-out/js/pages --watch",
+    "serve:11ty": "eleventy --serve --quiet",
+    "clean": "node _tools/cleanOutput.js",
+    "serve": "npm run clean && concurrently \"npm run serve:11ty\" \"npm run serve:css\" \"npm run serve:js\"",
+    "assistant": "node _tools/assistant.js",
+    "postinstall": "cd src/backend/_core && composer install --quiet"
+  }
 }

package/src/backend/_core/vendor/composer/autoload_static.php

@@ -13,48 +13,48 @@ class ComposerStaticInit108be68e4e2b97fed51d36a10eed0849
     );
 
     public static $prefixLengthsPsr4 = array (
-        'S' =>
+        'S' => 
         array (
             'Symfony\\Polyfill\\Php80\\' => 23,
             'Symfony\\Polyfill\\Mbstring\\' => 26,
             'Symfony\\Polyfill\\Ctype\\' => 23,
         ),
-        'P' =>
+        'P' => 
         array (
             'PhpOption\\' => 10,
         ),
-        'G' =>
+        'G' => 
         array (
             'GrahamCampbell\\ResultType\\' => 26,
         ),
-        'D' =>
+        'D' => 
         array (
             'Dotenv\\' => 7,
         ),
     );
 
     public static $prefixDirsPsr4 = array (
-        'Symfony\\Polyfill\\Php80\\' =>
+        'Symfony\\Polyfill\\Php80\\' => 
         array (
             0 => __DIR__ . '/..' . '/symfony/polyfill-php80',
         ),
-        'Symfony\\Polyfill\\Mbstring\\' =>
+        'Symfony\\Polyfill\\Mbstring\\' => 
         array (
             0 => __DIR__ . '/..' . '/symfony/polyfill-mbstring',
         ),
-        'Symfony\\Polyfill\\Ctype\\' =>
+        'Symfony\\Polyfill\\Ctype\\' => 
         array (
             0 => __DIR__ . '/..' . '/symfony/polyfill-ctype',
         ),
-        'PhpOption\\' =>
+        'PhpOption\\' => 
         array (
             0 => __DIR__ . '/..' . '/phpoption/phpoption/src/PhpOption',
         ),
-        'GrahamCampbell\\ResultType\\' =>
+        'GrahamCampbell\\ResultType\\' => 
         array (
             0 => __DIR__ . '/..' . '/graham-campbell/result-type/src',
         ),
-        'Dotenv\\' =>
+        'Dotenv\\' => 
         array (
             0 => __DIR__ . '/..' . '/vlucas/phpdotenv/src',
         ),