kaelum 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Matheus Messias
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+# Kaelum
+
+**Kaelum** is a minimalist Node.js framework designed to simplify the creation of web pages and REST APIs, especially for beginners. Inspired by Python's clean syntax and powered by Express.js, Kaelum automates project setup and server configuration with an intuitive CLI.
+
+## 📦 Installation
+
+You can create a new project with Kaelum using:
+
+```bash
+npx kaelum create
+````
+
+Then install dependencies and start your app:
+
+```bash
+cd my-project
+npm install
+npm start
+```
+
+> **Note:** No need to install Kaelum globally. `npx` handles it automatically!
+
+---
+
+## 🧠 Why Kaelum?
+
+* 📂 Minimalist MVC folder structure
+* ⚙️ Auto-configured Express setup
+* 🔒 Built-in support for CORS and Helmet
+* 🧱 Easy route management
+* 🧪 Great for learning and building quick prototypes
+
+---
+
+## 📁 Web Template Structure
+
+After running `npx kaelum create`, the web template structure looks like this:
+
+```
+my-web-app/
+├── public/          # Static files (e.g., CSS, JS)
+│   └── style.css
+├── views/           # HTML templates
+│   └── index.html
+├── controllers/     # Page controller logic
+│   └── .gitkeep
+├── middlewares/     # Custom middlewares
+│   └── example.js
+├── routes.js        # Route definitions
+├── app.js           # Server initialization
+└── package.json     # Project metadata and dependencies
+```
+
+---
+
+## 🚀 Features
+
+Kaelum exposes simple utilities that make it easy to build a web server:
+
+```js
+const kaelum = require('kaelum');
+const app = kaelum();
+```
+
+### 🌐 `addRoute(path, handlers)`
+
+Add routes with GET, POST, PUT, DELETE handlers in one place.
+
+```js
+addRoute('/home', {
+  get: (req, res) => res.send('GET: Welcome!'),
+  post: (req, res) => res.send('POST: Data received!')
+});
+```
+
+### 🔐 `setMiddleware(middleware)`
+
+Globally apply middleware to all routes.
+
+```js
+setMiddleware(require('helmet')());
+```
+
+### 🚀 `start(port)`
+
+Start the server.
+
+```js
+start(3000);
+```
+
+---
+
+## 👨‍💻 Local Development (for contributors)
+
+If you want to test or improve Kaelum locally:
+
+```bash
+git clone https://github.com/MatheusCampagnolo/kaelum.git
+cd kaelum
+npm link
+```
+
+Now you can run the CLI from anywhere:
+
+```bash
+npx kaelum create
+```
+
+---
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/cli/create.js

@@ -0,0 +1,52 @@
+const inquirer = require("inquirer");
+const inq = inquirer.default || inquirer;
+const path = require("path");
+const fs = require("fs-extra");
+const { copyTemplate } = require("./utils");
+
+const templatesDir = path.resolve(__dirname, "templates");
+
+async function createProject() {
+  console.log("🚀 Bem-vindo ao Kaelum CLI!");
+
+  const answers = await inq.prompt([
+    {
+      type: "input",
+      name: "projectName",
+      message: "Qual será o nome do seu projeto?",
+      validate: (input) => (input ? true : "O nome não pode ser vazio."),
+    },
+    {
+      type: "list",
+      name: "template",
+      message: "Qual template você deseja usar?",
+      choices: ["web", "api"],
+    },
+  ]);
+
+  const { projectName, template } = answers;
+  const targetDir = path.resolve(process.cwd(), projectName);
+  const templateDir = path.join(templatesDir, template);
+
+  if (template === "api") {
+    console.log(
+      '\n📦 O template API ainda está em desenvolvimento. Por favor, escolha o template "web".'
+    );
+    return;
+  }
+
+  if (fs.existsSync(targetDir)) {
+    console.error(
+      `\n❌ A pasta "${projectName}" já existe. Escolha outro nome ou apague a pasta existente.`
+    );
+    return;
+  }
+
+  await copyTemplate(templateDir, targetDir);
+
+  console.log(`\n✅ Projeto "${projectName}" criado com sucesso!`);
+  console.log(`➡️  Acesse a pasta: cd ${projectName}`);
+  console.log(`➡️  Inicie o projeto com: npm install && npm start\n`);
+}
+
+module.exports = { createProject };

package/cli/index.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+const { createProject } = require('./create');
+
+const [,, command] = process.argv;
+
+if (command === 'create') {
+  createProject();
+} else {
+  console.log(`Comando não reconhecido: ${command}`);
+  console.log(`Use: kaelum create`);
+}

package/cli/templates/web/app.js

@@ -0,0 +1,16 @@
+const kaelum = require('kaelum');
+const cors = require('cors');
+const helmet = require('helmet');
+
+const app = kaelum();
+
+// Middlewares globais (aplicados a todas as rotas)
+app.setMiddleware(cors());
+app.setMiddleware(helmet());
+
+// Importa e registra as rotas
+const routes = require('./routes');
+routes(app);
+
+// Inicia o servidor
+app.start(3000);

package/cli/templates/web/middlewares/logger.js

@@ -0,0 +1,6 @@
+function logger(req, res, next) {
+  console.log(`[${new Date().toISOString()}] ${req.method} ${req.url}`);
+  next();
+}
+
+module.exports = logger;

package/cli/templates/web/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "my-web-app",
+  "version": "1.0.0",
+  "description": "Project generated with Kaelum framework.",
+  "main": "app.js",
+  "scripts": {
+    "start": "node app.js"
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "helmet": "^7.0.0",
+    "kaelum": "^1.0.0"
+  },
+  "license": "MIT"
+}

package/cli/templates/web/public/style.css

@@ -0,0 +1,54 @@
+body {
+  margin: 0;
+  font-family: "Segoe UI", Tahoma, Geneva, Verdana, sans-serif;
+  background-color: #f9f9f9;
+  color: #333;
+}
+
+.container {
+  padding: 40px;
+  max-width: 800px;
+  margin: 0 auto;
+  text-align: center;
+}
+
+h1 {
+  font-size: 2.5rem;
+  margin-bottom: 10px;
+  color: #4a90e2;
+}
+
+p {
+  font-size: 1.1rem;
+  margin-bottom: 30px;
+}
+
+.info {
+  background-color: #fff;
+  padding: 20px;
+  border-radius: 8px;
+  box-shadow: 0 0 10px rgba(0, 0, 0, 0.05);
+}
+
+ul {
+  list-style-type: none;
+  padding: 0;
+}
+
+li {
+  text-align: left;
+  margin-bottom: 10px;
+}
+
+code {
+  background-color: #eee;
+  padding: 2px 6px;
+  border-radius: 4px;
+  font-family: monospace;
+}
+
+footer {
+  margin-top: 40px;
+  font-size: 0.9rem;
+  color: #999;
+}

package/cli/templates/web/routes.js

@@ -0,0 +1,27 @@
+const logger = require("./middlewares/logger");
+
+function Routes(app) {
+  app.addRoute("/", {
+    get: (req, res) => {
+      res.sendFile("views/index.html", { root: __dirname });
+    },
+    post: (req, res) => res.send("POST: Dados recebidos na página inicial."),
+  });
+
+  app.addRoute("/about", {
+    get: (req, res) => res.send("About page"),
+  });
+
+  // Rota "/secure" com middleware aplicado diretamente
+  app.addRoute("/secure", {
+    get: [
+      logger,
+      (req, res) => {
+        res.send("GET: Área segura! Middleware foi executado.");
+      },
+    ],
+  });
+  
+}
+
+module.exports = Routes;

package/cli/templates/web/views/index.html

@@ -0,0 +1,25 @@
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Kaelum.js - Welcome</title>
+    <link rel="stylesheet" href="/style.css" />
+  </head>
+  <body>
+    <div class="container">
+      <h1>🚀 Welcome to Kaelum.js</h1>
+      <p>Your minimalist framework to build APIs and web pages easily.</p>
+      <div class="info">
+        <h2>🧭 Start exploring</h2>
+        <ul>
+          <li><strong>Global Middlewares:</strong> See <code>app.js</code></li>
+          <li><strong>Routing:</strong> Edit <code>routes.js</code></li>
+          <li><strong>Static Files:</strong> Inside <code>public/</code></li>
+        </ul>
+      </div>
+      <footer>
+        <p>Made with ❤️ using Kaelum.js</p>
+      </footer>
+    </div>
+  </body>
+</html>

package/cli/utils.js

@@ -0,0 +1,12 @@
+const fs = require("fs-extra");
+const path = require("path");
+
+async function copyTemplate(sourceDir, targetDir) {
+  try {
+    await fs.copy(sourceDir, targetDir);
+  } catch (err) {
+    console.error("Erro ao copiar o template:", err);
+  }
+}
+
+module.exports = { copyTemplate };

package/core/addRoute.js

@@ -0,0 +1,11 @@
+function addRoute(app, path, handlers = {}) {
+  const supportedMethods = ['get', 'post', 'put', 'delete', 'patch'];
+
+  for (const method of supportedMethods) {
+    if (handlers[method]) {
+      app[method](path, handlers[method]);
+    }
+  }
+}
+
+module.exports = addRoute;

package/core/setMiddleware.js

@@ -0,0 +1,13 @@
+function setMiddleware(app, middleware) {
+  if (!app || typeof app.use !== 'function') {
+    throw new Error("Invalid app instance: cannot apply middleware");
+  }
+  
+  if (typeof middleware !== 'function') {
+    throw new Error("Middleware must be a function");
+  }
+
+  app.use(middleware);
+}
+
+module.exports = setMiddleware;

package/core/start.js

@@ -0,0 +1,8 @@
+function start(server, port, callback) {
+  server.listen(port, () => {
+    if (callback) callback();
+    else console.log(`Server running at http://localhost:${port}`);
+  });
+}
+
+module.exports = start;

package/createApp.js

@@ -0,0 +1,21 @@
+const express = require('express');
+const start = require('./core/start');
+const addRoute = require('./core/addRoute');
+const setMiddleware = require('./core/setMiddleware');
+
+function createApp() {
+  const app = express();
+
+  app.use(express.static('public'));
+  app.use(express.json());
+  app.use(express.urlencoded({ extended: true }));
+
+  // Encapsula as funções novas dentro do objeto app
+  app.start = (port, callback) => start(app, port, callback);
+  app.addRoute = (path, handlers) => addRoute(app, path, handlers);
+  app.setMiddleware = (middleware) => setMiddleware(app, middleware);
+
+  return app;
+}
+
+module.exports = createApp;

package/index.js

@@ -0,0 +1,3 @@
+const createApp = require("./createApp");
+
+module.exports = createApp;

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "kaelum",
+  "version": "1.0.0",
+  "description": "A minimalist Node.js framework for building web pages and APIs with simplicity and speed.",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js"
+  },
+  "bin": {
+    "kaelum": "./cli/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "framework",
+    "nodejs",
+    "express",
+    "cli",
+    "kaelum",
+    "api",
+    "web",
+    "minimal",
+    "starter"
+  ],
+  "author": "Matheus Campagnolo",
+  "license": "MIT",
+  "dependencies": {
+    "express": "^4.18.2",
+    "helmet": "^7.0.0",
+    "cors": "^2.8.5",
+    "fs-extra": "^11.3.0",
+    "inquirer": "^12.6.0"
+  }
+}