crypt-express-app 1.3.20

package/README.md

@@ -0,0 +1,329 @@
+# crypt-express-app
+
+🚀 A production-ready Express + TypeScript backend starter CLI with Prisma, Redis, i18n, Swagger, Docker, and scalable modular architecture.
+
+---
+
+## ✨ What is crypt-express-app?
+
+`crypt-express-app` is a CLI tool that instantly scaffolds a fully structured, enterprise-grade Express backend application.
+
+It generates:
+
+- Express + TypeScript setup
+- Prisma ORM configuration
+- PostgreSQL + Redis Docker setup
+- Swagger documentation
+- i18next internationalization
+- Modular folder architecture
+- Logger + Error handling middleware
+- Environment configuration
+- Ready-to-run Docker Compose stack
+
+This tool is built for developers who want a clean, scalable backend architecture in seconds.
+
+---
+
+# 📦 Installation
+
+You don’t install it globally.
+
+Use directly with npx:
+
+```bash
+npx crypt-express-app my-project
+```
+
+Or inside current directory:
+
+```bash
+npx crypt-express-app .
+```
+
+---
+
+# 🧠 What It Generates
+
+After running the CLI, your project will include:
+
+```
+my-project/
+│
+├── src/
+│   ├── app.ts
+│   ├── routes.ts
+│   ├── prisma/
+│   │   └── client.ts
+│   ├── utils/
+│   ├── middlewares/
+│   ├── locales/
+│   └── modules/
+│
+├── prisma/
+│   └── schema.prisma
+├── server.ts
+├── .env
+├── .env.dev
+├── .env.prod
+├── example.env
+├── Dockerfile
+├── docker-compose.yml
+├── tsconfig.json
+└── package.json
+```
+
+---
+
+# 🔥 Features
+
+## ✅ Express + TypeScript
+- Clean app architecture
+- Modular routing system
+- Centralized error handling
+- Logger middleware
+
+## ✅ Prisma ORM
+- PostgreSQL configuration
+- Auto Prisma client setup
+- prisma.config.ts support
+
+## ✅ Redis Cache
+- Redis service container
+- Cache service wrapper
+- TTL-based caching support
+
+## ✅ Internationalization (i18n)
+- English + Bengali support
+- Language detection
+- JSON-based translations
+
+## ✅ Swagger API Docs
+- OpenAPI 3.0 setup
+- Bearer auth support
+- Persist authorization enabled
+
+Access at:
+
+```
+http://localhost:3000/api/docs
+```
+
+## ✅ Docker Ready
+- Node service container
+- PostgreSQL container
+- Redis container
+- Volume persistence
+- Production-ready configuration
+
+---
+
+# 🚀 Quick Start
+
+After project generation:
+
+```bash
+cd my-project
+```
+
+Start infrastructure:
+
+```bash
+docker compose up -d postgres redis
+```
+
+Generate Prisma client:
+
+```bash
+npx prisma generate
+```
+
+Run development server:
+
+```bash
+pnpm dev
+```
+
+Or build and run:
+
+```bash
+pnpm build
+pnpm start
+```
+
+---
+
+# 🌍 Environment Variables
+
+Default `.env`:
+
+```
+PORT=3000
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/app_db
+IAM_REDIS_URL=redis://localhost:6379
+```
+
+For Docker (`.env.dev`):
+
+```
+DATABASE_URL=postgresql://postgres:postgres@postgres:5432/app_db
+IAM_REDIS_URL=redis://redis:6379
+```
+
+---
+
+# 🐳 Docker Usage
+
+Start everything:
+
+```bash
+docker compose up --build
+```
+
+Only database + redis:
+
+```bash
+docker compose up -d postgres redis
+```
+
+Stop:
+
+```bash
+docker compose down
+```
+
+---
+
+# 🧩 Architecture Philosophy
+
+crypt-express-app follows a clean separation:
+
+- `app.ts` → Express configuration
+- `routes.ts` → Route registration
+- `modules/` → Feature modules
+- `utils/` → Shared services
+- `middlewares/` → Cross-cutting concerns
+- `prisma/` → Database client layer
+
+This makes scaling large backend systems easier.
+
+---
+
+# 📌 CLI Behavior
+
+If project name contains spaces:
+
+```
+"My App Project"
+```
+
+It auto converts to:
+
+```
+my-app-project
+```
+
+---
+
+# 🛠 Scripts
+
+Generated project includes:
+
+```json
+"dev": "nodemon",
+"build": "tsc && npm run copy-locales",
+"start": "node dist/server.js"
+```
+
+---
+
+# 📚 Requirements
+
+- Node.js 18+
+- pnpm or npm
+- Docker (optional but recommended)
+- PostgreSQL
+- Redis
+
+---
+
+# 🔐 Production Ready
+
+This starter includes:
+
+- Structured logging
+- Error middleware
+- Swagger security
+- Environment separation
+- Docker orchestration
+- Prisma adapter configuration
+
+You can safely use this as a base for:
+
+- SaaS backend
+- Microservices
+- Enterprise REST APIs
+- Auth servers
+- Admin panels
+
+---
+
+# 🤝 Contributing
+
+Pull requests are welcome.
+
+1. Fork repository
+2. Create feature branch
+3. Submit PR
+
+---
+
+# 📄 License
+
+ISC
+
+---
+
+# 👨‍💻 Author
+
+Abir Hosen
+
+---
+
+# ⭐ Why crypt-express-app?
+
+Because setting up backend boilerplate repeatedly is painful.
+
+crypt-express-app removes:
+
+- Folder setup time
+- Docker setup time
+- Prisma configuration time
+- Redis setup time
+- Swagger configuration time
+- i18n wiring time
+
+Start coding business logic immediately.
+
+---
+
+# 🚀 Future Roadmap
+
+- Auth module generator
+- Role-based access control
+- GraphQL support
+- Microservice mode
+- CLI flags support
+- Health check system
+- CI/CD template
+
+---
+
+Enjoy building scalable backends 🚀
+
+
+## 🔗 Links
+
+- 🌐 Website: [Cryptdox](https://cryptdox.com)
+- 📦 NPM Package: [crypt-express-app](https://www.npmjs.com/package/crypt-express-app)
+- 👤 Portfolio: [abir.cryptdox.com](http://abir.cryptdox.com)
+- 📧 Email: abir71.hosen@gmail.com