1.0.3 • Published 6 months ago

mvc-model-generator v1.0.3

Weekly downloads
-
License
ISC
Repository
github
Last release
6 months ago

MVC Model Generator

A Node.js script to generate directory structures for MVC-based applications.

šŸ“Œ Features

āœ… Automatically creates directories for an MVC application
āœ… Supports configurable file structures
āœ… Simple and easy to use


šŸ“„ Installation

Using npm (for general use)

npm install -g mvc-model-generator

šŸš€ Usage

After linking the package, you can import and use it in your Node.js script:

import { init } from "mvc-model-generator";

init();

This will generate the following directory structure in the current working directory:

šŸ“‚ project-root
 ā”œā”€ā”€ šŸ“‚ config
 ā”œā”€ā”€ šŸ“‚ public
 │   ā”œā”€ā”€ šŸ“‚ css
 │   ā”œā”€ā”€ šŸ“‚ js
 │   ā”œā”€ā”€ šŸ“‚ images
 ā”œā”€ā”€ šŸ“‚ src
 │   ā”œā”€ā”€ šŸ“‚ models
 │   ā”œā”€ā”€ šŸ“‚ views
 │   ā”œā”€ā”€ šŸ“‚ controllers
 │   ā”œā”€ā”€ šŸ“‚ routes
 │   ā”œā”€ā”€ šŸ“‚ middleware
 ā”œā”€ā”€ šŸ“‚ test

āš™ļø Configuration (Optional)

If you want to customize the directory structure, modify the fileTree array inside index.js:

const fileTree = [
    "config",
    {"public": ["css", "js", "images"]},
    {"src": ["models", "views", "controllers", "routes", "middleware"]},
    "test"
];

šŸ› ļø Development

Cloning the Repo

git clone https://github.com/MB-PieSec/MVC-Model-Generator.git
cd MVC-Model-Generator
npm install

šŸ“œ License

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


šŸ“® Contributing

Feel free to submit issues or pull requests on GitHub:
šŸ”— GitHub Repository

1.0.3

6 months ago

1.0.2

6 months ago

1.0.1

6 months ago

1.0.0

6 months ago