https://github.com/arya2004/auto-express
CLI to generate Express.js projects
https://github.com/arya2004/auto-express
express hacktober hacktoberfest hacktoberfest-accepted hacktoberfest-starter hacktoberfest2024 npm-package
Last synced: 11 months ago
JSON representation
CLI to generate Express.js projects
- Host: GitHub
- URL: https://github.com/arya2004/auto-express
- Owner: arya2004
- License: mit
- Created: 2023-12-12T18:17:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T15:24:24.000Z (over 1 year ago)
- Last Synced: 2024-11-19T16:36:36.706Z (over 1 year ago)
- Topics: express, hacktober, hacktoberfest, hacktoberfest-accepted, hacktoberfest-starter, hacktoberfest2024, npm-package
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@arya2004/auto-express
- Size: 72.3 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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:
```bash
npm install -g @arya2004/auto-express
```
---
## Usage
### **Start an Interactive CLI**
To initialize a new project with interactive prompts:
```bash
auto init
```
### **Generate a New Express API Project**
To quickly create a new API project with a specified name:
```bash
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](CONTRIBUTING.md) for guidelines on submitting pull requests, reporting issues, and more.
---
## Code of Conduct
This project follows a [Code of Conduct](CODE_OF_CONDUCT.md). 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](LICENSE.md) file for more details.
---
Happy coding! 🚀