create-express-easy
v1.0.5
Published
Custom project initializer for Code Biruni ecosystem
Maintainers
Readme
🚀 create-express-easy
create-express-easy is the official project starter for the Code Biruni ecosystem. It helps you scaffold a professional Express.js (MERN) backend with a clean, modular architecture in seconds.
⚡ Quick Start
To ensure you are using the most up-to-date features and templates, always run the initializer using the @latest tag:
npx create-express-easy@latest <your-project-name>🛠️ Next Steps:
# Navigate to your project directory
cd <your-project-name>
# Setup your environment variables (refer to .env.example)
# Then start the development server
npm run dev📁 What's Inside?
Scaffolding your project with this tool provides a production-ready backend architecture:
- ✅ Modern Structure: Modular and clean folder organization.
- ✅ Authentication: Pre-configured auth system and security middlewares.
- ✅ Database Ready: Built-in MongoDB (Mongoose) integration.
- ✅ Cloudinary: Complete setup for seamless image uploads.
- ✅ Email System: Robust email sending system with customizable templates.
- ✅ Chatbot: Integrated AI-ready chatbot module.
- ✅ Security: Essential security headers and middlewares pre-installed.
You're absolutely right to catch that! My apologies—the previous response accidentally generated Google Search links instead of the direct GitHub repository links. Since you want this to point directly to your repo, we should use the relative paths (which work perfectly on GitHub) or the full URLs.
Here is the corrected Documentation table for your README.md using your GitHub repository links:
📚 Documentation
| Topic | Documentation Link | | :--- | :--- | | 🚀 Getting Started | Project Initializer | | 🔑 Environment | Environment Setup | | ⚙️ Configuration | Config Setup | | 🏗️ Architecture | Module Structure | | 🛡️ Security | Auth Middleware | | 🛠️ Custom Logic | Custom Middleware | | 🖼️ File Upload | Upload Image & Cloudinary | | 🔗 Routing | Router Guide | | 📧 Mailing | Send Email & Templates | | 🤖 AI Support | Chatbot Module | | 🌍 Deployment | Deployment Guide |
🛠️ Available Scripts
Once the project is generated, you can use the following commands:
npm run dev: Starts the project in development mode with Nodemon.npm run build: Builds the project for production.npm run start: Starts the production server.
👨💻 Author
Robius Sani Founder of Code Biruni
- GitHub: @Robius-Sani
- Website: Documentation
📄 License
This project is licensed under the ISC License.
Developed with ❤️ by Code Biruni Team.
