create-fastpress 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.2.0] - 2026-03-12
+
+### Added
+- Interactive CLI with user-friendly prompts using @clack/prompts
+- Database adapter selection (PostgreSQL, MySQL/MariaDB, SQLite)
+- Automatic FastPress configuration generation based on selected adapter
+- Environment variables template generation
+- Prisma schema provider configuration
+- Complete project template with sample module
+
+### Changed
+- Enhanced project creation workflow with better user experience
+- Improved error handling and validation

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 create-fastpress
+
+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,110 @@
+# create-fastpress
+
+[![npm version](https://img.shields.io/npm/v/create-fastpress.svg)](https://www.npmjs.com/package/create-fastpress)
+[![npm downloads](https://img.shields.io/npm/dm/create-fastpress.svg)](https://www.npmjs.com/package/create-fastpress)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Official CLI tool for **[FastPress](https://www.npmjs.com/package/@cristianrg/fastpress)** - The simple and fast backend framework for building backend applications with TypeScript and Prisma.
+
+## 🚀 Quick Start
+
+Create a new FastPress project in seconds:
+
+```bash
+npx create-fastpress
+```
+
+That's it! The CLI will guide you through the setup process interactively.
+
+![fastpress-cli](resources/fastpress-cli.gif)
+
+## ✨ Features
+
+- 🎯 **Interactive CLI** - User-friendly prompts guide you through project setup
+- 🗄️ **Database Adapter Selection** - Choose from PostgreSQL, MySQL/MariaDB, or SQLite
+- 📦 **Ready-to-use Template** - Complete project structure with best practices
+- ⚡ **Quick Setup** - Get started in seconds with sensible defaults
+- 🔧 **Pre-configured** - Prisma, TypeScript, and FastPress configured out of the box
+
+## 📋 Prerequisites
+
+- **Node.js** >= 18.0.0
+- **npm**, **pnpm**, or **yarn**
+
+## 🎨 What You'll Get
+
+Running `npx create-fastpress` will create a new project with:
+
+- ✅ Complete FastPress project structure
+- ✅ TypeScript configuration
+- ✅ Prisma ORM setup with your chosen database adapter
+- ✅ Sample module (controller, service, and Zod schemas)
+- ✅ Environment variables template (.env)
+- ✅ FastPress configuration file
+- ✅ Ready-to-use scripts (dev, build, setup)
+
+## 🛠️ Usage
+
+### Interactive Mode (Recommended)
+
+Simply run:
+
+```bash
+npx create-fastpress
+```
+
+The CLI will prompt you for:
+1. **Project name** - Your new project directory name
+2. **Database adapter** - Choose your preferred database:
+   - PostgreSQL
+   - MySQL/MariaDB
+   - SQLite
+   - Skip adapter setup (configure later)
+
+### Next Steps
+
+After creating your project:
+
+```bash
+# 1. Navigate to your project
+cd your-project-name
+
+# 2. Install dependencies
+npm install
+
+# 3. Configure your database connection in .env file
+# (Already templated with sensible defaults)
+
+# 4. Run database setup
+npm run setup
+
+# 5. Start development server
+npm run dev
+```
+
+Your FastPress API will be running! 🎉
+
+## 📚 Documentation
+
+For more information about FastPress framework:
+
+- **NPM Package**: [@cristianrg/fastpress](https://www.npmjs.com/package/@cristianrg/fastpress)
+- **GitHub**: [FastPress Repository](https://github.com/CristianRG/fastpress#readme)
+
+## 🤝 Contributing
+
+Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/CristianRG/create-fastpress/issues).
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 👨‍💻 Author
+
+Created with 💙 by **Cristian Alexander Rizo Gómez**
+
+- GitHub: [@CristianRG](https://github.com/CristianRG)
+
+## ⭐ Support
+
+If you find this project useful, please consider giving it a star on [GitHub](https://github.com/CristianRG/create-fastpress)!

package/dist/index.js

@@ -0,0 +1,194 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import chalk from 'chalk';
+import * as p from '@clack/prompts';
+import { readFileSync, writeFileSync } from 'fs';
+import { join } from 'path';
+import { __project_dirname } from './utils.js';
+import { existsSync, mkdirSync, copyFileSync, readdirSync, statSync } from 'fs';
+const packageJson = JSON.parse(readFileSync(join(__project_dirname, '../package.json'), 'utf-8'));
+const program = new Command();
+const copyFolder = (src, dest, excludeFiles = []) => {
+    if (!existsSync(dest)) {
+        mkdirSync(dest);
+    }
+    const entries = readdirSync(src, { withFileTypes: true });
+    for (const entry of entries) {
+        // Skip excluded files
+        if (excludeFiles.includes(entry.name)) {
+            continue;
+        }
+        const srcPath = join(src, entry.name);
+        const destPath = join(dest, entry.name);
+        const stats = statSync(srcPath);
+        if (stats.isDirectory()) {
+            copyFolder(srcPath, destPath, excludeFiles);
+        }
+        else if (stats.isFile()) {
+            copyFileSync(srcPath, destPath);
+        }
+    }
+};
+const getAdapterProvider = (adapterName) => {
+    const providerMap = {
+        '@prisma/adapter-pg': 'postgresql',
+        '@prisma/adapter-mariadb': 'mysql',
+        '@prisma/adapter-better-sqlite3': 'sqlite'
+    };
+    return providerMap[adapterName] || 'sqlite';
+};
+const generateFastpressConfig = (adapterName) => {
+    const configs = {
+        '@prisma/adapter-pg': {
+            import: 'import { PrismaPg } from "@prisma/adapter-pg";',
+            className: 'PrismaPg',
+            config: 'new PrismaPg({ connectionString: process.env["DATABASE_URL"] || "postgresql://user:password@localhost:5432/mydb" })',
+            docUrl: 'https://www.prisma.io/docs/orm/core-concepts/supported-databases/postgresql#using-driver-adapters'
+        },
+        '@prisma/adapter-mariadb': {
+            import: 'import { PrismaMariaDb } from "@prisma/adapter-mariadb";',
+            className: 'PrismaMariaDb',
+            config: `new PrismaMariaDb({
+        host: process.env["DATABASE_HOST"] || "localhost",
+        port: parseInt(process.env["DATABASE_PORT"] || "3306"),
+        connectionLimit: 5,
+    })`,
+            docUrl: 'https://www.prisma.io/docs/orm/core-concepts/supported-databases/mysql#using-driver-adapters'
+        },
+        '@prisma/adapter-better-sqlite3': {
+            import: 'import { PrismaBetterSqlite3 } from "@prisma/adapter-better-sqlite3";',
+            className: 'PrismaBetterSqlite3',
+            config: 'new PrismaBetterSqlite3({ url: process.env["DATABASE_URL"] || "file:./prisma/dev.db" })',
+            docUrl: 'https://www.prisma.io/docs/orm/core-concepts/supported-databases/sqlite#using-driver-adapters'
+        }
+    };
+    const adapterConfig = configs[adapterName];
+    if (!adapterConfig) {
+        // No adapter selected
+        return `import { defineFastPressConfig } from "@cristianrg/fastpress";
+
+export default defineFastPressConfig({
+    server: {
+        // Configure your Prisma adapter here
+        // See: https://www.prisma.io/docs/orm/core-concepts/supported-databases
+    }
+})`;
+    }
+    return `import { defineFastPressConfig } from "@cristianrg/fastpress";
+${adapterConfig.import}
+
+// For more information about this adapter, visit:
+// ${adapterConfig.docUrl}
+
+export default defineFastPressConfig({
+    server: {
+        prismaAdapter: ${adapterConfig.config}
+    }
+})`;
+};
+const generateEnvFile = (adapterName) => {
+    const envConfigs = {
+        '@prisma/adapter-pg': 'DATABASE_URL=postgresql://user:password@localhost:5432/mydb',
+        '@prisma/adapter-mariadb': 'DATABASE_URL=mysql://user:password@localhost:3306/mydb',
+        '@prisma/adapter-better-sqlite3': 'DATABASE_URL=file:./prisma/dev.db'
+    };
+    return envConfigs[adapterName] || 'DATABASE_URL=sqlite:./dev.db';
+};
+const createProject = async (projectName, adapter) => {
+    const projectDir = join(process.cwd(), projectName);
+    if (!existsSync(projectDir)) {
+        mkdirSync(projectDir);
+    }
+    else {
+        console.error(chalk.red(`Directory ${projectName} already exists. Please choose a different name or remove the existing directory.`));
+        process.exit(1);
+    }
+    const templateDir = join(__project_dirname, '..', 'src', 'template');
+    if (existsSync(templateDir) && statSync(templateDir).isDirectory()) {
+        const files = readdirSync(templateDir);
+        copyFolder(templateDir, projectDir, ['fastpress.config.ts', '.env']);
+    }
+    else {
+        console.error(chalk.red('Template directory not found. Please ensure the template files are in place.'));
+        process.exit(1);
+    }
+    const fastpressConfigPath = join(projectDir, 'fastpress.config.ts');
+    const fastpressConfigContent = generateFastpressConfig(adapter.name);
+    writeFileSync(fastpressConfigPath, fastpressConfigContent);
+    const envPath = join(projectDir, '.env');
+    const envContent = generateEnvFile(adapter.name);
+    writeFileSync(envPath, envContent);
+    const schemaPath = join(projectDir, 'prisma', 'schema.prisma');
+    if (existsSync(schemaPath)) {
+        const schemaContent = readFileSync(schemaPath, 'utf-8');
+        const provider = getAdapterProvider(adapter.name);
+        const updatedSchema = schemaContent.replace(/(datasource\s+db\s*\{[^}]*provider\s*=\s*)"[^"]+"/, `$1"${provider}"`);
+        writeFileSync(schemaPath, updatedSchema);
+    }
+    const projectPackageJsonPath = join(projectDir, 'package.json');
+    if (existsSync(projectPackageJsonPath)) {
+        const projectPackageJson = JSON.parse(readFileSync(projectPackageJsonPath, 'utf-8'));
+        projectPackageJson.dependencies['@cristianrg/fastpress'] = `^${packageJson.version}`;
+        projectPackageJson.name = projectName;
+        if (adapter.name !== 'none') {
+            projectPackageJson.dependencies[adapter.name] = adapter.version;
+        }
+        writeFileSync(projectPackageJsonPath, JSON.stringify(projectPackageJson, null, 2));
+    }
+    else {
+        console.error(chalk.red('package.json not found in the template. Please ensure the template files are in place.'));
+        process.exit(1);
+    }
+    console.log(chalk.green(`Project ${projectName} created successfully!`));
+    console.log(chalk.green(`Next steps:`));
+    console.log(chalk.green(`1. Navigate to your project directory: cd ${projectName}`));
+    console.log(chalk.green(`2. Install dependencies: npm install`));
+    console.log(chalk.green(`3. Set up your database connection string in the .env file`));
+    console.log(chalk.green(`4. Run Setup script to initialize the database: npm run setup`));
+    console.log(chalk.green(`5. Start the development server: npm run dev`));
+};
+const createFastpress = async () => {
+    console.log(chalk.green(`Welcome to Fastpress ${packageJson.version}!`));
+    console.log(chalk.gray(`Current directory: ${process.cwd()}`));
+    p.intro(chalk.green('Let\'s create your Fastpress project!'));
+    const project = await p.group({
+        path: () => p.text({
+            message: 'What is the name of your project?',
+            placeholder: 'my-fastpress-app',
+            validate: (value) => {
+                if (!value)
+                    return 'Project name is required';
+                if (value.includes(' '))
+                    return 'Project name cannot contain spaces';
+            },
+        }),
+        type: ({ results }) => p.select({
+            message: 'Select your prisma adapter',
+            options: [
+                { value: '@prisma/adapter-pg', label: 'PostgreSQL' },
+                { value: '@prisma/adapter-mariadb', label: 'MySQL/MariaDB' },
+                { value: '@prisma/adapter-better-sqlite3', label: 'SQLite' },
+                { value: 'none', label: 'Skip adapter setup' }
+            ]
+        })
+    }, {
+        onCancel: () => {
+            p.cancel('Project creation cancelled.');
+            process.exit(0);
+        }
+    });
+    p.outro(chalk.green(`Creating project ${project.path}${project.type !== 'none' ? ` with adapter ${project.type}` : ''}...`));
+    await createProject(project.path, { name: project.type, version: 'latest' });
+};
+program
+    .version(packageJson.version)
+    .description('Create a new Fastpress project')
+    .action(() => {
+    createFastpress();
+});
+if (process.argv.length === 2) {
+    createFastpress();
+}
+else {
+    program.parse(process.argv);
+}

package/dist/utils.js

@@ -0,0 +1,5 @@
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __project_dirname = dirname(__filename);
+export { __project_dirname };

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "create-fastpress",
+  "version": "1.2.0",
+  "description": "Official CLI for FastPress, the simple and fast backend framework for building backend applications with TypeScript and Prisma.",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CristianRG/create-fastpress.git"
+  },
+  "bugs": {
+    "url": "https://github.com/CristianRG/create-fastpress/issues"
+  },
+  "homepage": "https://github.com/CristianRG/create-fastpress#readme",
+  "bin": {
+    "create-fastpress": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "src/template",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "fastpress",
+    "cli",
+    "typescript",
+    "prisma",
+    "api",
+    "backend",
+    "framework",
+    "scaffold",
+    "generator",
+    "create-app",
+    "boilerplate"
+  ],
+  "type": "module",
+  "author": "Cristian Alexander Rizo Gómez",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "25.3.0",
+    "tsc-alias": "1.8.16",
+    "typescript": "5.9.3"
+  },
+  "dependencies": {
+    "@clack/prompts": "1.0.1",
+    "chalk": "5.6.2",
+    "commander": "14.0.3"
+  },
+  "scripts": {
+    "build": "tsc && tsc-alias",
+    "start": "node dist/index.js",
+    "pack:check": "npm pack --dry-run"
+  }
+}

package/src/template/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "my-fastpress-app",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "nodemon --watch src --ext ts --exec \"npm run build && npm start\"",
+    "setup": "npx prisma migrate dev --name init && npx prisma generate"
+  },
+  "dependencies": {
+    "@cristianrg/fastpress": "^1.2.0",
+    "@prisma/client": ">=5.0.0",
+    "zod": "4.3.6"
+  },
+  "devDependencies": {
+    "@types/node": "^25.3.3",
+    "prisma": ">=5.0.0",
+    "typescript": "^5.9.3",
+    "nodemon": "^3.1.11"
+  }
+}

package/src/template/prisma/schema.prisma

@@ -0,0 +1,32 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+// Looking for ways to speed up your queries, or scale easily with your serverless or edge functions?
+// Try Prisma Accelerate: https://pris.ly/cli/accelerate-init
+
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "sqlite"
+}
+
+model User {
+  id    String  @id @default(uuid())
+  name  String
+  email String  @unique
+  password String
+
+  sessions Session[]
+}
+
+model Session {
+  id        String  @id @default(uuid())
+  userId    String
+  token     String   @unique
+  createdAt DateTime @default(now())
+  expiresAt DateTime
+
+  user User @relation(fields: [userId], references: [id])
+}

package/src/template/prisma.config.ts

@@ -0,0 +1,14 @@
+// This file was generated by Prisma, and assumes you have installed the following:
+// npm install --save-dev prisma dotenv
+import "dotenv/config";
+import { defineConfig } from "prisma/config";
+
+export default defineConfig({
+  schema: "prisma/schema.prisma",
+  migrations: {
+    path: "prisma/migrations",
+  },
+  datasource: {
+    url: process.env["DATABASE_URL"],
+  },
+});

package/src/template/src/index.ts

@@ -0,0 +1,20 @@
+import { createServer } from "@cristianrg/fastpress";
+
+// You can register your controllers, services, and other modules here if needed.
+// Remember all .controller.ts files in the src/modules directory are automatically registered as controllers by FastPress, so you don't need to manually import them here unless you want to customize their registration
+// or if you want to register internal modules by fastpress that are not in the src/modules directory.
+// For example:
+
+/*
+import { createServer, AuthController } from '@cristianrg/fastpress';
+
+await createServer({
+    controllers: [AuthController],
+});
+
+*/
+
+createServer((app) => {
+    console.log("Your FastPress server is running!");
+    console.log("Visit http://localhost:3000/hello to see the Hello World controller in action.");
+});

package/src/template/src/modules/helloword.zod.ts

@@ -0,0 +1,7 @@
+import z from "zod";
+
+const HelloWorldSchema = z.object({
+    who: z.string().optional()
+});
+
+export { HelloWorldSchema };

package/src/template/src/modules/helloworld.controller.ts

@@ -0,0 +1,29 @@
+import { Controller, Get, Post, Body, ZodValidationPipe, ServerResponse } from "@cristianrg/fastpress";
+import { HelloWorldSchema } from "./helloword.zod";
+import z from "zod";
+import { HelloWorldService } from "./helloworld.service";
+
+@Controller("/hello")
+class HelloworldController {
+    
+    @Get("/")
+    async getHelloWorld() {
+        const message = HelloWorldService.getHelloWorld();
+        return new ServerResponse(200, message);
+    }
+
+    /*
+        * This endpoint demonstrates how to use Zod for validating request bodies in FastPress.
+        * It accepts an optional "who" parameter in the request body, which defaults to "World" if not provided.
+    */
+    @Post("/")
+    async postHelloWorld(
+        @Body(undefined, new ZodValidationPipe(HelloWorldSchema)) body: z.infer<typeof HelloWorldSchema>
+    ) {
+        const who = body.who || "World";
+        const message = `Hello, ${who}!`;
+        return new ServerResponse(200, message);
+    }
+}
+
+export default HelloworldController;

package/src/template/src/modules/helloworld.service.ts

@@ -0,0 +1,8 @@
+class HelloWorldService {
+    
+    static getHelloWorld(): string {
+        return "Hello, World!";
+    }
+}
+
+export { HelloWorldService }

package/src/template/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "lib": ["ES2022"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}