nibula 1.0.0

package/docs/Styling with SCSS.md

@@ -0,0 +1,136 @@
+# Styling with SCSS
+
+## Page CSS
+
+Each page has its own SCSS entry point in `src/frontend/scss/pages/`
+
+It must contain `_root.scss` + other modules like `_global.scss` or any other one that you need and its own specific css rules
+
+`_root.scss` uses `@use` to enable namespaced access (`root.$var`); other modules use `@import` as they don't expose variables.
+### examplePage.scss <small>(`src/frontend/scss/pages/`)</small>
+```scss
+//==========================
+// CSS MODULES IMPORTS
+//==========================
+
+@use "../modules/root" as root;
+
+@import "../modules/global";
+
+//==========================
+// PAGE CUSTOM CSS RULES
+//==========================
+
+body {
+  background-color: root.$primary;
+}
+```
+
+## 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 |
+| `_animations.scss` | Keyframe animations (`fade-in`, `spin`) |
+
+## CSS Framework
+
+Some of the most popular css frameworks that supports scss with modules are already installed in `node_modules`
+
+You can choose one or none of them (more than 1 works, but you may get in various conflicts)
+
+To enable/disable them you have to modify 3 files around the project by just commenting them
+
+
+### 1. _global.scss <small>(`src/frontend/scss/modules/`)</small>
+```scss
+@import "../modules/frameworks/bootstrap";
+// @import "../modules/frameworks/bulma";
+// @import "../modules/frameworks/foundation";
+// @import "../modules/frameworks/uikit";
+```
+
+### 2. base.njk <small>(`src/frontend/layouts/`)</small>
+
+```html
+{# Bootstrap JS #}
+<script src="/js/bootstrap.bundle.min.js" defer></script>
+
+{# Foundation JS #}
+{# <script src="/js/foundation.min.js" defer></script> #}
+
+{# UIkit JS #}
+{# <script src="/js/uikit.min.js" defer></script> #}
+{# <script src="/js/uikit-icons.min.js" defer></script> #}
+
+{# Bulma — no JS needed #}
+```
+
+### 3. .eleventy.js
+
+```javascript
+eleventyConfig.addPassthroughCopy({
+  // Bootstrap
+  "node_modules/bootstrap/dist/js/bootstrap.bundle.min.js": "js/bootstrap.bundle.min.js",
+  "node_modules/bootstrap-icons/font/fonts": "css/fonts",
+
+  // Foundation
+  // "node_modules/foundation-sites/dist/js/foundation.min.js": "js/foundation.min.js",
+
+  // UIkit
+  // "node_modules/uikit/dist/js/uikit.min.js": "js/uikit.min.js",
+  // "node_modules/uikit/dist/js/uikit-icons.min.js": "js/uikit-icons.min.js",
+
+  // Bulma — CSS only, no JS passthrough needed
+});
+```
+
+### Reducing bundle size
+To reduce the bundle size, open the corresponding framework file (`src/frontend/scss/modules/frameworks/`) and comment out any modules you don't need
+```scss
+@import "bootstrap/scss/card"; // Cards
+@import "bootstrap/scss/carousel"; // Carousel
+```

package/nginx.conf

@@ -0,0 +1,47 @@
+# Hide the nginx version from response headers
+server_tokens off;
+
+# Force HTTPS on future requests (applies site-wide, including /api)
+add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
+
+root /var/www/html/out;
+index index.html;
+
+# Disable directory listing
+autoindex off;
+
+error_page 403 404 /404.html;
+location = /404.html {
+    internal;
+}
+
+# Never expose the backend source directory
+location ^~ /backend/ {
+    return 404;
+}
+
+# Block server config files anywhere in the tree (.htaccess, web.config).
+# return 404 is served internally as /404.html via error_page above.
+location ~* (^|/)(\.htaccess|web\.config)$ {
+    return 404;
+}
+
+# Route all /api/ requests to the PHP front controller.
+# Security headers for API responses are set by the front controller (PHP).
+location ^~ /api/ {
+    try_files $uri =404;
+    fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
+    fastcgi_param SCRIPT_FILENAME $document_root/backend/_core/index.php;
+    include fastcgi_params;
+}
+
+# Serve static files, fall back to the 404 page.
+# A location with add_header does not inherit server-level headers,
+# so Strict-Transport-Security is repeated here.
+location / {
+    add_header X-Content-Type-Options "nosniff" always;
+    add_header X-Frame-Options "SAMEORIGIN" always;
+    add_header Referrer-Policy "strict-origin-when-cross-origin" always;
+    add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
+    try_files $uri $uri/ /404.html;
+}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "nibula",
+  "version": "1.0.0",
+  "description": "A beginner-friendly static site generator built on Eleventy that stays close to vanilla HTML, CSS and JS — with a page-management CLI, an optional PHP backend, and SEO files generated for you.",
+  "keywords": [
+    "static-site-generator",
+    "ssg",
+    "eleventy",
+    "11ty",
+    "boilerplate",
+    "starter",
+    "scaffolding",
+    "cli",
+    "vanilla",
+    "vanilla-js",
+    "html",
+    "css",
+    "scss",
+    "sass",
+    "njk",
+    "nunjucks",
+    "components",
+    "backend",
+    "php",
+    "node",
+    "python",
+    "beginner-friendly",
+    "seo",
+    "sitemap",
+    "website-template",
+    "frontend"
+  ],
+  "author": "Michele Garofalo",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/Rhaastrake/Nibula#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rhaastrake/Nibula.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Rhaastrake/Nibula/issues"
+  },
+  "outputDir": "out",
+  "bin": {
+    "nib": "bin/nibula.js",
+    "nbl": "bin/nibula.js",
+    "nibula": "bin/nibula.js"
+  },
+  "scripts": {
+    "build:css": "sass src/frontend/scss:out/css --no-source-map --style=compressed --quiet",
+    "build:js": "esbuild \"src/frontend/ts/pages/*.ts\" --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/ts/pages/*.ts\" --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"
+  },
+  "devDependencies": {
+    "@11ty/eleventy": "^3.1.2",
+    "@11ty/eleventy-img": "^6.0.4",
+    "bootstrap": "^5.3.8",
+    "bootstrap-icons": "^1.13.1",
+    "bulma": "^1.0.4",
+    "concurrently": "^9.2.1",
+    "esbuild": "^0.27.3",
+    "foundation-sites": "^6.9.0",
+    "glob": "^13.0.6",
+    "sass": "^1.77.0",
+    "uikit": "^3.25.13"
+  }
+}

package/src/backend/.htaccess

@@ -0,0 +1,7 @@
+<IfModule mod_rewrite.c>
+    RewriteEngine On
+    RewriteBase /api/
+
+    RewriteRule ^_core/index\.php$ - [L]
+    RewriteRule ^(.*)$ _core/index.php [QSA,L]
+</IfModule>

package/src/backend/_core/composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "vlucas/phpdotenv": "^5.6"
+    }
+}