UCG (Universal CRUD Generator)

A powerful, database-first CRUD generator for Node.js applications. UCG provides an interactive CLI and web dashboard to generate models, controllers, services, and API endpoints for your database tables.

🚀 Features

• Database-First Approach: Introspect existing databases to generate code
• Multiple ORM Support: Prisma, Sequelize, Mongoose adapters
• Web Dashboard: Interactive UI for code generation served from node_modules
• CLI Tools: ucg init and ucg quick-setup commands
• Pluggable Architecture: Easy to add new databases and ORMs
• Auto-Generated API Docs: Swagger/OpenAPI documentation
• Modern UI: Clean, responsive dashboard with preview capabilities
• No File Pollution: Everything served from the plugin, minimal host project changes

📦 Installation

npm install ucg

🎯 Quick Start

Option 1: Add to Existing Project

# Install in your existing Node.js project
npm install ucg

# Initialize UCG (adds routes to your app.js/server.js)
npx ucg init

# Start your application and visit /ucg/setup
npm start

Option 2: Create New Project

# Create a new project with UCG pre-configured
npx ucg quick-setup

# Follow the prompts, then:
cd your-project-name
npm install
npm start

# Visit http://localhost:3000/ucg/setup

🛠️ Usage

CLI Commands

ucg init

Adds UCG to an existing Node.js project by mounting the router.

npx ucg init [--json]  # --json for machine-readable output

ucg quick-setup

Creates a new Node.js project with UCG pre-configured.

npx ucg quick-setup [--json]

Dashboard URLs

After running ucg init or ucg quick-setup, these URLs will be available:

• /ucg/setup - First-time configuration wizard
• /ucg/login - Dashboard login
• /ucg/dashboard - Main dashboard with table overview
• /ucg/generate/model - Model generator
• /ucg/generate/crud - CRUD generator
• /ucg/api-docs - Auto-generated API documentation

🗄️ Database Support

PostgreSQL (Primary)

• Prisma: Full introspection, model generation, CRUD operations
• Sequelize: Table structure detection, model/controller generation
• Mongoose: Mock adapter (demonstrates architecture)

Extensible Architecture

The database-first folder structure makes it easy to add new databases:

src/databases/
├── postgresql/          # Database folder
│   ├── prisma/         # ORM adapter
│   ├── sequelize/      # ORM adapter
│   └── mongoose/       # ORM adapter
└── mysql/              # Future: Add MySQL support
    ├── prisma/
    ├── sequelize/
    └── typeorm/

🎨 Generated Code Structure

UCG generates clean, production-ready code:

your-project/
├── src/
│   ├── controllers/     # Express controllers with full CRUD
│   ├── services/        # Business logic layer
│   ├── routes/          # Express routes with middleware
│   ├── models/          # ORM models (Prisma/Sequelize/etc)
│   ├── validation/      # Input validation middleware
│   └── tests/           # Unit tests for generated code

🔧 Configuration

UCG stores its configuration in node_modules/ucg/.ucg/config.json - no files are created in your project root.

Example Configuration

{
  "database": "postgresql",
  "orm": "prisma", 
  "credentials": {
    "host": "localhost",
    "port": 5432,
    "database": "myapp",
    "user": "postgres",
    "tablePrefix": "app_"
  },
  "user": {
    "email": "admin@example.com"
  }
}

🚦 API Generation

Generated Endpoints

For each model, UCG generates RESTful endpoints:

GET    /models          # List with pagination
GET    /models/:id      # Get by ID  
POST   /models          # Create new
PUT    /models/:id      # Update
DELETE /models/:id      # Delete

Features

• Pagination: Built-in pagination support
• Validation: Input validation middleware
• Relationships: Foreign key relationships populated
• Error Handling: Consistent error responses
• Swagger Docs: Auto-generated API documentation

🧪 Testing

UCG generates unit tests for all generated code:

# Test the plugin itself
npm test

# Test generated code in your project
npm test  # Run tests for generated models/controllers

Package Testing

Test the UCG package before publishing:

# Create tarball
npm pack

# Install in test project
cd /path/to/test-project
npm install /path/to/ucg-1.0.0.tgz

# Test functionality
npx ucg init
# ... test dashboard and generation

🎯 Development

Project Structure

ucg/
├── package.json
├── bin/ucg                    # CLI entry point
├── src/
│   ├── index.js              # Main exports
│   ├── server.js             # Standalone server (dev)
│   ├── cli/                  # CLI implementations
│   │   ├── init.js
│   │   └── quick-setup.js
│   ├── databases/            # Database-first adapters
│   │   └── postgresql/
│   │       ├── prisma/       # Prisma adapter
│   │       ├── sequelize/    # Sequelize adapter  
│   │       └── mongoose/     # Mongoose adapter
│   ├── ui/                   # Web dashboard
│   │   ├── routes/           # Express routes
│   │   ├── views/            # Handlebars templates
│   │   └── static/           # CSS/JS assets
│   ├── lib/                  # Utilities
│   │   ├── config.js         # Configuration management
│   │   └── utils.js          # Helper functions
│   └── tests/                # Unit tests
├── .ucg-config.example.json  # Example configuration
└── README.md

Running in Development

# Clone and setup
git clone <repo>
cd ucg
npm install

# Run development server
npm run dev

# Run tests
npm test

# Lint code
npm run lint

🔒 Security

• Password Hashing: User passwords hashed with bcrypt
• Configuration Security: Database credentials stored in plugin directory
• Input Validation: All generated endpoints include validation
• No Secrets: No hardcoded secrets in the repository

📚 API Reference

CLI Integration

When you run ucg init, it adds these lines to your app:

// CommonJS
const ucg = require('ucg');
app.use('/ucg', ucg.router);

// ES Modules  
import ucg from 'ucg';
app.use('/ucg', ucg.router);

Programmatic Usage

const { router } = require('ucg');
const configManager = require('ucg/src/lib/config');
const utils = require('ucg/src/lib/utils');

// Mount UCG in your app
app.use('/admin/ucg', router);

// Access configuration
const config = await configManager.getConfig();

// Use utilities
const modelName = utils.tableNameToModelName('user_profiles');

🛣️ Roadmap

Current Version (1.0.0)

• ✅ PostgreSQL + Prisma/Sequelize support
• ✅ Web dashboard with modern UI
• ✅ Model and CRUD generation
• ✅ CLI tools (init, quick-setup)
• ✅ Auto-generated API documentation

Future Enhancements

• More Databases: MySQL, SQLite, MSSQL
• More ORMs: TypeORM, Knex.js
• Advanced Features:
  • Custom templates
  • Bulk operations
  • API versioning
  • GraphQL generation
• UI Improvements:
  • Code editor with syntax highlighting
  • Dark mode
  • Mobile responsiveness

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Adding New Database Support

1. Create folder: src/databases/your-database/
2. Add ORM adapters following the interface:
   • introspectTables(connectionConfig)
   • generateModelCode(table, options)
   • generateCRUD(model, options)
   • testConnection(connectionConfig)

📄 License

MIT License - see LICENSE file for details.

🙋‍♂️ Support

• 📖 Documentation
• 🐛 Issues
• 💬 Discussions

Made with ❤️ by the UCG team. Happy coding! 🚀