Skip to content

arya2004/auto-express

Repository files navigation

Express Project Generator

A generator for Express.js projects with database connections, caching, and MVC/API structures.


Features

  • Express.js Project Templates: Generate projects with MVC or API structures.
  • Database Integration: Connect to major databases like MongoDB, PostgreSQL, MySQL, and SQLServer.
  • View Engine Support: Optional setup for popular view engines (EJS, Pug, Handlebars) for MVC projects.
  • Demo Included: Provides a basic weather model, controller, and API endpoint as an example.
  • Customizable: Interactive CLI allows you to configure projects according to your requirements.

Installation

Install the generator globally to use it as a CLI tool:

npm install -g @arya2004/auto-express

Usage

Start an Interactive CLI

To initialize a new project with interactive prompts:

auto init

Generate a New Express API Project

To quickly create a new API project with a specified name:

auto new my-express-api

This command sets up a new Express.js API project with MongoDB integration and basic scaffolding.


Contributing

Contributions are welcome! If you'd like to contribute, please check the Contributing Guide for guidelines on submitting pull requests, reporting issues, and more.


Code of Conduct

This project follows a Code of Conduct. By participating, you agree to maintain a welcoming and respectful environment for all contributors and users.


License

This project is licensed under the MIT License. See the LICENSE file for more details.


Happy coding! 🚀