create-rag-app 0.1.0 → 0.1.2

package/README.md

@@ -1,49 +1,53 @@
-# Create RAG App
-
-Scaffold a production-ready RAG (Retrieval Augmented Generation) application in seconds.
-
-## Features
-
-- 🚀 **Next.js & React**: Modern frontend with Tailwind setup.
-- 🦜 **LangChain**: Best-in-class RAG pipeline.
-- 🗄️ **ChromaDB**: Built-in local vector database.
-- 🤖 **Multi-LLM Support**: Switch between OpenAI, Groq, and Ollama.
-- 📄 **Document Ingestion**: Simple script to index PDFs and Text files.
-
-## Usage
-
-```bash
-# Run directly with npx
-npx create-rag-app my-ai-project
-
-# Or install globally
-npm install -g create-rag-app
-create-rag-app my-ai-project
-```
-
-## Structure Result
-
-The created app will have:
-
-- `src/app`: User Interface (Chat)
-- `src/lib`: RAG Utilities
-- `scripts/ingest.js`: Document processor
-- `documents/`: Folder to drop your knowledge base
-
-## Development
-
-```bash
-# Clone the repo
-git clone https://github.com/your-username/create-rag-app.git
-
-# Install dependencies
-npm install
-
-# Test locally
-npm link
-create-rag-app test-project
-```
-
-## License
-
-MIT
+# Create RAG App
+
+Scaffold a production-ready RAG (Retrieval Augmented Generation) application in seconds.
+
+[![npm version](https://img.shields.io/npm/v/create-rag-app.svg)](https://www.npmjs.com/package/create-rag-app)
+[![npm downloads](https://img.shields.io/npm/dt/create-rag-app.svg)](https://www.npmjs.com/package/create-rag-app)
+
+
+## Features
+
+- 🚀 **Next.js & React**: Modern frontend with Tailwind setup.
+- 🦜 **LangChain**: Best-in-class RAG pipeline.
+- 🗄️ **ChromaDB**: Built-in local vector database.
+- 🤖 **Multi-LLM Support**: Switch between OpenAI, Groq, and Ollama.
+- 📄 **Document Ingestion**: Simple script to index PDFs and Text files.
+
+## Usage
+
+```bash
+# Run directly with npx
+npx create-rag-app my-ai-project
+
+# Or install globally
+npm install -g create-rag-app
+create-rag-app my-ai-project
+```
+
+## Structure Result
+
+The created app will have:
+
+- `src/app`: User Interface (Chat)
+- `src/lib`: RAG Utilities
+- `scripts/ingest.js`: Document processor
+- `documents/`: Folder to drop your knowledge base
+
+## Development
+
+```bash
+# Clone the repo
+git clone https://github.com/your-username/create-rag-app.git
+
+# Install dependencies
+npm install
+
+# Test locally
+npm link
+create-rag-app test-project
+```
+
+## License
+
+MIT

package/bin/cli.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
-
-import { main } from "../src/index.js";
-
-main().catch((err) => {
-    console.error(err);
-    process.exit(1);
-});
+
+import { main } from "../src/index.js";
+
+main().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rag-app",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Scaffold a new RAG application",
   "type": "module",
   "bin": {
@@ -24,6 +24,14 @@
     "chroma",
     "ai"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/itwaasyou/create-rag-app.git"
+  },
+  "homepage": "https://github.com/itwaasyou/create-rag-app",
+  "bugs": {
+    "url": "https://github.com/itwaasyou/create-rag-app/issues"
+  },
   "license": "MIT",
   "dependencies": {
     "chalk": "^5.6.2",

package/src/index.js

@@ -1,65 +1,65 @@
-import path from "path";
-import fs from "fs-extra";
-import chalk from "chalk";
-import { Command } from "commander";
-import { getOptions } from "./prompts.js";
-import { checkDir, copyTemplate, installDependencies } from "./utils.js";
-
-const packageJson = JSON.parse(
-    await fs.readFile(new URL("../package.json", import.meta.url))
-);
-
-export async function main() {
-    console.log(chalk.bold.cyan("\n🚀 Welcome to Create RAG App!\n"));
-
-    let projectName;
-
-    const program = new Command(packageJson.name)
-        .version(packageJson.version)
-        .arguments('[project-directory]')
-        .usage(`${chalk.green('[project-directory]')} [options]`)
-        .action((name) => {
-            projectName = name;
-        })
-        .parse(process.argv);
-
-    const options = await getOptions(projectName);
-    const projectPath = path.resolve(process.cwd(), options.projectName);
-
-    console.log(`\nCreating a new RAG app in: ${chalk.green(projectPath)}\n`);
-
-    // Ensure directory doesn't exist
-    checkDir(projectPath);
-
-    // Copy template
-    // We need to map the template option to a folder name
-    // The 'value' in prompts.js choices is 'nextjs-rag', so ensure that folder exists in templates/
-    const templateName = options.template;
-    await copyTemplate(templateName, projectPath);
-
-    // Configure Environment Variables
-    const envExamplePath = path.join(projectPath, ".env.example");
-    const envPath = path.join(projectPath, ".env");
-
-    if (await fs.pathExists(envExamplePath)) {
-        await fs.copy(envExamplePath, envPath);
-        console.log(chalk.green("✔ Created .env file from example"));
-
-        // Inject selected provider config
-        let envContent = await fs.readFile(envPath, "utf-8");
-        envContent += `\n# Auto-generated config\n`;
-        envContent += `LLM_PROVIDER=${options.provider}\n`;
-        envContent += `VECTOR_DB=${options.vectorDb}\n`;
-        await fs.writeFile(envPath, envContent);
-    }
-
-    // Install Dependencies (user requested automatic installation)
-    await installDependencies(projectPath);
-
-    // Final Success Message
-    console.log(chalk.bold.green("\n🎉 Success! Your RAG app is ready."));
-    console.log(chalk.yellow("\nNext steps:"));
-    console.log(chalk.cyan(`  cd ${options.projectName}`));
-    console.log(chalk.cyan(`  npm run dev`));
-    console.log("");
-}
+import path from "path";
+import fs from "fs-extra";
+import chalk from "chalk";
+import { Command } from "commander";
+import { getOptions } from "./prompts.js";
+import { checkDir, copyTemplate, installDependencies } from "./utils.js";
+
+const packageJson = JSON.parse(
+    await fs.readFile(new URL("../package.json", import.meta.url))
+);
+
+export async function main() {
+    console.log(chalk.bold.cyan("\n🚀 Welcome to Create RAG App!\n"));
+
+    let projectName;
+
+    const program = new Command(packageJson.name)
+        .version(packageJson.version)
+        .arguments('[project-directory]')
+        .usage(`${chalk.green('[project-directory]')} [options]`)
+        .action((name) => {
+            projectName = name;
+        })
+        .parse(process.argv);
+
+    const options = await getOptions(projectName);
+    const projectPath = path.resolve(process.cwd(), options.projectName);
+
+    console.log(`\nCreating a new RAG app in: ${chalk.green(projectPath)}\n`);
+
+    // Ensure directory doesn't exist
+    checkDir(projectPath);
+
+    // Copy template
+    // We need to map the template option to a folder name
+    // The 'value' in prompts.js choices is 'nextjs-rag', so ensure that folder exists in templates/
+    const templateName = options.template;
+    await copyTemplate(templateName, projectPath);
+
+    // Configure Environment Variables
+    const envExamplePath = path.join(projectPath, ".env.example");
+    const envPath = path.join(projectPath, ".env");
+
+    if (await fs.pathExists(envExamplePath)) {
+        await fs.copy(envExamplePath, envPath);
+        console.log(chalk.green("✔ Created .env file from example"));
+
+        // Inject selected provider config
+        let envContent = await fs.readFile(envPath, "utf-8");
+        envContent += `\n# Auto-generated config\n`;
+        envContent += `LLM_PROVIDER=${options.provider}\n`;
+        envContent += `VECTOR_DB=${options.vectorDb}\n`;
+        await fs.writeFile(envPath, envContent);
+    }
+
+    // Install Dependencies (user requested automatic installation)
+    await installDependencies(projectPath);
+
+    // Final Success Message
+    console.log(chalk.bold.green("\n🎉 Success! Your RAG app is ready."));
+    console.log(chalk.yellow("\nNext steps:"));
+    console.log(chalk.cyan(`  cd ${options.projectName}`));
+    console.log(chalk.cyan(`  npm run dev`));
+    console.log("");
+}

package/src/prompts.js

@@ -1,66 +1,66 @@
-
-import inquirer from "inquirer";
-
-export async function getOptions(initialProjectName) {
-    let questions = [
-        {
-            type: "input",
-            name: "projectName",
-            message: "What is your project named?",
-            default: "my-rag-app",
-            validate: (input) => {
-                if (/^([a-z0-9\-\_\.]+)$/.test(input)) return true;
-                return "Project name may only include letters, numbers, dashes, and underscores.";
-            },
-        },
-        {
-            type: "list",
-            name: "template",
-            message: "Which template would you like to use?",
-            choices: [
-                { name: "Next.js + LangChain + ChromaDB (Recommended)", value: "nextjs-rag" },
-                { name: "Express API + PDF Processor (Backend Only)", value: "express-rag" }, // Future scope
-            ],
-            default: "nextjs-rag",
-        },
-        {
-            type: "list",
-            name: "provider",
-            message: "Which LLM provider do you want configured?",
-            choices: [
-                { name: "OpenAI (GPT-4o, GPT-3.5)", value: "openai" },
-                { name: "Groq (Llama 3, Mixtral - Fast!)", value: "groq" },
-                { name: "Ollama (Local Models)", value: "ollama" },
-                { name: "Gemini (Google DeepMind)", value: "gemini" },
-            ],
-            default: "openai",
-        },
-        {
-            type: "list",
-            name: "vectorDb",
-            message: "Which Vector Database do you want to use?",
-            choices: [
-                { name: "ChromaDB (Local)", value: "chroma" },
-                { name: "Supabase pgvector (Cloud)", value: "supabase" },
-            ],
-            default: "chroma",
-        },
-    ];
-
-    if (initialProjectName) {
-        if (/^([a-z0-9\-\_\.]+)$/.test(initialProjectName)) {
-            // Valid project name provided via CLI, skip the prompt
-            questions = questions.filter(q => q.name !== "projectName");
-        } else {
-            console.log("⚠ Invalid project name provided via CLI.");
-            initialProjectName = null; // Force prompt
-        }
-    }
-
-    const answers = await inquirer.prompt(questions);
-
-    return {
-        projectName: initialProjectName || answers.projectName,
-        ...answers
-    };
-}
+
+import inquirer from "inquirer";
+
+export async function getOptions(initialProjectName) {
+    let questions = [
+        {
+            type: "input",
+            name: "projectName",
+            message: "What is your project named?",
+            default: "my-rag-app",
+            validate: (input) => {
+                if (/^([a-z0-9\-\_\.]+)$/.test(input)) return true;
+                return "Project name may only include letters, numbers, dashes, and underscores.";
+            },
+        },
+        {
+            type: "list",
+            name: "template",
+            message: "Which template would you like to use?",
+            choices: [
+                { name: "Next.js + LangChain + ChromaDB (Recommended)", value: "nextjs-rag" },
+                { name: "Express API + PDF Processor (Backend Only)", value: "express-rag" }, // Future scope
+            ],
+            default: "nextjs-rag",
+        },
+        {
+            type: "list",
+            name: "provider",
+            message: "Which LLM provider do you want configured?",
+            choices: [
+                { name: "OpenAI (GPT-4o, GPT-3.5)", value: "openai" },
+                { name: "Groq (Llama 3, Mixtral - Fast!)", value: "groq" },
+                { name: "Ollama (Local Models)", value: "ollama" },
+                { name: "Gemini (Google DeepMind)", value: "gemini" },
+            ],
+            default: "openai",
+        },
+        {
+            type: "list",
+            name: "vectorDb",
+            message: "Which Vector Database do you want to use?",
+            choices: [
+                { name: "ChromaDB (Local)", value: "chroma" },
+                { name: "Supabase pgvector (Cloud)", value: "supabase" },
+            ],
+            default: "chroma",
+        },
+    ];
+
+    if (initialProjectName) {
+        if (/^([a-z0-9\-\_\.]+)$/.test(initialProjectName)) {
+            // Valid project name provided via CLI, skip the prompt
+            questions = questions.filter(q => q.name !== "projectName");
+        } else {
+            console.log("⚠ Invalid project name provided via CLI.");
+            initialProjectName = null; // Force prompt
+        }
+    }
+
+    const answers = await inquirer.prompt(questions);
+
+    return {
+        projectName: initialProjectName || answers.projectName,
+        ...answers
+    };
+}

package/src/utils.js

@@ -1,62 +1,62 @@
-
-import fs from "fs-extra";
-import path from "path";
-import chalk from "chalk";
-import { exec } from "child_process";
-import util from "util";
-import ora from "ora";
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const execAsync = util.promisify(exec);
-
-export function checkDir(targetPath) {
-    if (fs.existsSync(targetPath)) {
-        console.error(chalk.red(`\n❌ Error: Directory ${path.basename(targetPath)} already exists.`));
-        process.exit(1);
-    }
-}
-
-export async function copyTemplate(templateName, targetPath) {
-    const spinner = ora("Copying project files...").start();
-
-    // Assuming templates live in ../templates relative to this file
-    const templateDir = path.resolve(__dirname, "../templates", templateName);
-
-    if (!fs.existsSync(templateDir)) {
-        spinner.fail(chalk.red(`Template ${templateName} not found at ${templateDir}`));
-        process.exit(1);
-    }
-
-    try {
-        await fs.copy(templateDir, targetPath);
-        spinner.succeed(chalk.green("Project files created successfully."));
-    } catch (err) {
-        spinner.fail(chalk.red("Failed to copy files."));
-        console.error(err);
-        process.exit(1);
-    }
-}
-
-export async function installDependencies(targetPath) {
-    const spinner = ora("Installing dependencies... This might take a moment.").start();
-
-    try {
-        // Run npm install in the new directory
-        await execAsync("npm install", { cwd: targetPath });
-        spinner.succeed(chalk.green("Dependencies installed via npm."));
-    } catch (err) {
-        // Fallback for peer dependency conflicts common in AI libraries
-        try {
-            spinner.text = "Retrying with --legacy-peer-deps...";
-            await execAsync("npm install --legacy-peer-deps", { cwd: targetPath });
-            spinner.succeed(chalk.green("Dependencies installed with legacy peer deps."));
-        } catch (retryErr) {
-            spinner.fail(chalk.red("Failed to install dependencies."));
-            console.log(chalk.yellow("You can try installing manually:"));
-            console.log(chalk.cyan(`  cd ${path.basename(targetPath)}`));
-            console.log(chalk.cyan("  npm install --legacy-peer-deps"));
-        }
-    }
-}
+
+import fs from "fs-extra";
+import path from "path";
+import chalk from "chalk";
+import { exec } from "child_process";
+import util from "util";
+import ora from "ora";
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const execAsync = util.promisify(exec);
+
+export function checkDir(targetPath) {
+    if (fs.existsSync(targetPath)) {
+        console.error(chalk.red(`\n❌ Error: Directory ${path.basename(targetPath)} already exists.`));
+        process.exit(1);
+    }
+}
+
+export async function copyTemplate(templateName, targetPath) {
+    const spinner = ora("Copying project files...").start();
+
+    // Assuming templates live in ../templates relative to this file
+    const templateDir = path.resolve(__dirname, "../templates", templateName);
+
+    if (!fs.existsSync(templateDir)) {
+        spinner.fail(chalk.red(`Template ${templateName} not found at ${templateDir}`));
+        process.exit(1);
+    }
+
+    try {
+        await fs.copy(templateDir, targetPath);
+        spinner.succeed(chalk.green("Project files created successfully."));
+    } catch (err) {
+        spinner.fail(chalk.red("Failed to copy files."));
+        console.error(err);
+        process.exit(1);
+    }
+}
+
+export async function installDependencies(targetPath) {
+    const spinner = ora("Installing dependencies... This might take a moment.").start();
+
+    try {
+        // Run npm install in the new directory
+        await execAsync("npm install", { cwd: targetPath });
+        spinner.succeed(chalk.green("Dependencies installed via npm."));
+    } catch (err) {
+        // Fallback for peer dependency conflicts common in AI libraries
+        try {
+            spinner.text = "Retrying with --legacy-peer-deps...";
+            await execAsync("npm install --legacy-peer-deps", { cwd: targetPath });
+            spinner.succeed(chalk.green("Dependencies installed with legacy peer deps."));
+        } catch (retryErr) {
+            spinner.fail(chalk.red("Failed to install dependencies."));
+            console.log(chalk.yellow("You can try installing manually:"));
+            console.log(chalk.cyan(`  cd ${path.basename(targetPath)}`));
+            console.log(chalk.cyan("  npm install --legacy-peer-deps"));
+        }
+    }
+}

package/templates/nextjs-rag/.env.example

@@ -1,13 +1,13 @@
-
-# AI Provider Keys
-OPENAI_API_KEY=sk-your-key-here
-GROQ_API_KEY=your-groq-key
-GOOGLE_API_KEY=your-gemini-key-here
-
-# Vector DB
-# Default to local persistent client
-CHROMA_URL=http://localhost:8000
-COLLECTION_NAME=rag-docs
-
-# App Config
-NEXT_PUBLIC_APP_NAME="My RAG App"
+
+# AI Provider Keys
+OPENAI_API_KEY=sk-your-key-here
+GROQ_API_KEY=your-groq-key
+GOOGLE_API_KEY=your-gemini-key-here
+
+# Vector DB
+# Default to local persistent client
+CHROMA_URL=http://localhost:8000
+COLLECTION_NAME=rag-docs
+
+# App Config
+NEXT_PUBLIC_APP_NAME="My RAG App"

package/templates/nextjs-rag/documents/readme.txt

@@ -1,2 +1,2 @@
-Put your PDF or .txt files here to be ingested by the RAG pipeline.
+Put your PDF or .txt files here to be ingested by the RAG pipeline.
 Then run `npm run ingest` to build the vector index.

package/templates/nextjs-rag/jsconfig.json

@@ -1,15 +1,15 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "@/*": ["./src/*"]
-    },
-    // Useful for Next.js strict mode and modern JS features
-    "target": "ESNext",
-    "module": "ESNext",
-    "jsx": "preserve",
-    "strict": false
-  },
-  "include": ["next-env.d.ts", "**/*.js", "**/*.jsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
-}
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    },
+    // Useful for Next.js strict mode and modern JS features
+    "target": "ESNext",
+    "module": "ESNext",
+    "jsx": "preserve",
+    "strict": false
+  },
+  "include": ["next-env.d.ts", "**/*.js", "**/*.jsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}

package/templates/nextjs-rag/next.config.mjs

@@ -1,7 +1,7 @@
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-    reactStrictMode: true,
-    serverExternalPackages: ["chromadb"],
-};
-
-export default nextConfig;
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+    reactStrictMode: true,
+    serverExternalPackages: ["chromadb"],
+};
+
+export default nextConfig;