@sidgaikwad/db-setup 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 siddharth
+
+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,169 @@
+# 🗄️ Create DB Setup
+
+> Interactive CLI for setting up PostgreSQL databases with multiple providers
+
+[![npm version](https://badge.fury.io/js/%40sidgaikwad%2Fcreate-db-setup.svg)](https://www.npmjs.com/package/@sidgaikwad/create-db-setup)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## ✨ Features
+
+- 🎯 **Multiple Providers**: Neon, Supabase, Railway, Local Docker
+- 🌍 **Region Selection**: Choose from 11+ global regions with emoji flags
+- ⚙️ **Auto Configuration**: Automatically writes database URL to .env
+- 📁 **Custom .env Paths**: Support for any .env file location (.env, .env.local, config/.env, etc.)
+- 🏷️ **Custom Variable Names**: Use any variable name (DATABASE_URL, POSTGRES_URL, DB_URL, etc.)
+- 💾 **Safe Updates**: Creates backups before modifying files
+- 🔒 **Overwrite Protection**: Asks before overwriting existing variables
+- 🎨 **Beautiful CLI**: Color-coded, interactive prompts
+- 🛡️ **Type Safe**: Written in TypeScript
+- 🚀 **Zero Config**: Works out of the box with Bun or Node.js
+- ⚡ **Fast**: Optimized for Bun runtime
+
+## 🚀 Quick Start
+
+### Run with bunx (Recommended)
+
+```bash
+bunx @sidgaikwad/create-db-setup
+```
+
+### Or with npx
+
+```bash
+npx @sidgaikwad/create-db-setup
+```
+
+### Or Install Globally
+
+```bash
+# With Bun
+bun install -g @sidgaikwad/create-db-setup
+
+# With npm
+npm install -g @sidgaikwad/create-db-setup
+
+# Then run
+create-db-setup
+```
+
+### Or use the shorter alias
+
+```bash
+bunx @sidgaikwad/create-db-setup
+# or after global install
+db-setup
+```
+
+## 📦 Supported Providers
+
+### 🔷 Neon (Serverless PostgreSQL)
+
+- Automatic CLI authentication
+- 11 global regions (AWS + Azure)
+- Pooled connections
+- Free tier available
+
+### 🟢 Supabase (Open Source Firebase Alternative)
+
+- Project creation via CLI
+- Global region selection
+- Connection pooling
+- Generous free tier
+
+### 🚂 Railway (Platform as a Service)
+
+- One-click PostgreSQL deployment
+- Automatic environment variables
+- Simple pricing
+
+### 🐳 Local Docker
+
+- Instant local PostgreSQL
+- Pre-configured docker-compose
+- Perfect for development
+
+## 🎯 Usage
+
+Simply run the CLI and follow the prompts:
+
+```bash
+$ bunx @sidgaikwad/create-db-setup
+
+================ Database Setup ================
+
+? Choose your PostgreSQL provider:
+  ❯ Neon (Serverless)
+    Supabase (Cloud)
+    Railway
+    Local PostgreSQL (Docker)
+    I already have a DATABASE_URL
+    I'll configure later
+
+[Select your provider and follow the interactive setup]
+
+================ Environment Configuration ================
+
+? Enter the path to your .env file: .env
+? Enter the environment variable name for your database URL: DATABASE_URL
+
+✅ DATABASE_URL has been added to your .env file!
+```
+
+### Flexible Configuration
+
+The CLI now supports:
+
+- **Custom .env file paths**: `.env`, `.env.local`, `config/.env`, etc.
+- **Custom variable names**: `DATABASE_URL`, `POSTGRES_URL`, `DB_CONNECTION_STRING`, etc.
+- **Automatic backup**: Creates `.env.backup` before making changes
+- **Overwrite protection**: Asks before overwriting existing variables
+
+## 🛠️ Requirements
+
+- Node.js >= 18.0.0 OR Bun >= 1.0.0
+- npm or yarn or pnpm or bun
+
+## 📚 API
+
+You can also use this as a library in your own Node.js projects:
+
+```typescript
+import { setupNeon, setupSupabase } from "@sidgaikwad/create-db-setup";
+
+// Use individual provider setups
+const databaseUrl = await setupNeon();
+
+// Or use the interactive CLI
+import { handleDatabaseSetup } from "@sidgaikwad/create-db-setup";
+const databaseUrl = await handleDatabaseSetup();
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## 📝 License
+
+MIT © [siddharth]
+
+## 🙏 Acknowledgments
+
+- [@inquirer/prompts](https://github.com/SBoudrias/Inquirer.js) for interactive CLI
+- [chalk](https://github.com/chalk/chalk) for terminal styling
+- All the database providers for their excellent CLIs
+
+## 🐛 Known Issues
+
+See [GitHub Issues](https://github.com/sidgaikwad/create-db-setup/issues)
+
+## 📮 Support
+
+- 📧 Email: gaikwadsiddharth039@gmail.com
+- 🐦 Twitter: [_sidd24_](https://twitter.com/_sidd24_)
+- 💬 Discord: [Join our server](https://discord.gg/mJp3dckf)

package/bin/cli.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+// This file serves as the executable entry point
+// It imports and runs the compiled TypeScript code
+require("../dist/index.js");

package/dist/database.d.ts

@@ -0,0 +1,2 @@
+export declare function handleDatabaseSetup(): Promise<string>;
+//# sourceMappingURL=database.d.ts.map

package/dist/database.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.d.ts","sourceRoot":"","sources":["../src/database.ts"],"names":[],"mappings":"AAQA,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAmF3D"}

package/dist/env.d.ts

@@ -0,0 +1,30 @@
+interface EnvConfig {
+    envPath: string;
+    variableName: string;
+}
+/**
+ * Initialize .env file from .env.example if it exists
+ */
+export declare function initializeEnvFile(): void;
+/**
+ * Ask user for .env file location and variable name
+ */
+export declare function getEnvConfig(): Promise<EnvConfig>;
+/**
+ * Write database URL to .env file
+ */
+export declare function writeDatabaseUrl(databaseUrl: string, config: EnvConfig): Promise<void>;
+/**
+ * Show the configured database URL (masked for security)
+ */
+export declare function showDatabaseUrl(databaseUrl: string, variableName: string): void;
+/**
+ * Validate if a string is a valid PostgreSQL connection string
+ */
+export declare function validateConnectionString(url: string): boolean;
+/**
+ * Complete environment setup flow
+ */
+export declare function setupEnvironment(databaseUrl: string): Promise<void>;
+export {};
+//# sourceMappingURL=env.d.ts.map

package/dist/env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../src/env.ts"],"names":[],"mappings":"AAKA,UAAU,SAAS;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CASxC;AAED;;GAEG;AACH,wBAAsB,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC,CAwHvD;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,IAAI,CAAC,CAqDf;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,GACnB,IAAI,CAMN;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAG7D;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAiBzE"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}