create-xpress-starter
v1.3.3
Published
A customizable boilerplate to quickly start an Express.js project with support for JavaScript and TypeScript, and MVC architecture.
Downloads
138
Maintainers
Readme
🌟 Create Xpress Starter
create-xpress-starter
is a powerful and customizable boilerplate to quickly set up an Express.js project. It supports both JavaScript and TypeScript, and allows you to choose between MVC and Layered Architecture patterns.
🚀 Introduction
create-xpress-starter
is designed to streamline your Express.js development by providing a ready-made, customizable boilerplate. Whether you prefer JavaScript or TypeScript, MVC or Layered Architecture, this starter kit has you covered.
✨ Features
- 🌐 JavaScript and TypeScript support
- 🗂️ Choice of architectural patterns: MVC or Layered Architecture
- 🛠️ Pre-configured ESLint and Prettier for code quality and formatting
- 🔄 Error handling setup
- 📦 Example folder structure and essential files
- 🚀 Ready to use development and production scripts
🏁 Getting Started
Installation
To create a new project, run:
npx create-xpress-starter
Project Setup
After running the command, you'll be prompted to choose your preferred language and architectural pattern:
? Enter the folder name for your project (leave blank for current folder):
? Which language would you like to use? (Use arrow keys)
❯ TypeScript
JavaScript
? Which architectural pattern would you like to use? (Use arrow keys)
❯ Model-View-Controller (MVC) Pattern
Layered Architecture Pattern (Modular)
🛠️ Configuration
- ESLint: For code quality checks.
- Prettier: For code formatting.
- Error Handling: Pre-configured error handling middleware.
📄 License
This project is licensed under the MIT License.
💬 Support
For any issues or questions, please open an issue on the GitHub repository.
🎉 Contributions
Contributions are welcome! Please follow the standard GitHub flow:
- Fork the repository.
- Create a new branch.
- Make your changes.
- Open a pull request
Enjoy building your Express.js applications with create-xpress-starter
! 🚀