API Craft CLI Tool

API Craft CLI Tool is a command-line utility designed to streamline the setup of Node.js API projects, ensuring a well-structured and organized codebase. It automates the creation of essential files and folders, enhances code readability, and improves development productivity.

Features

• Automatically generates controller, DTO, model, route, service, and validation files based on predefined templates.
• Integrated global error handling to eliminate repetitive try-catch blocks and ensure robust error management.
• Encourages best practices by enforcing a consistent file structure across projects.
• Simplifies project initialization and module creation.

Prerequisites

Before using the API Craft CLI Tool, ensure you have the following installed:

• Node.js (version 12 or higher)
• npm (Node Package Manager)

Installation

You can install the API Craft CLI Tool globally using npm:

npm install -g apicraft

Usage

Initializing a New Project

To initialize a new project with API Craft:

npx apicraft init

This command sets up the following structure in your project directory:

project-root/
├── src/
│   ├── configs/
│   ├── controllers/
│   ├── dtos/
│   ├── interfaces/
│   ├── mails/
│   ├── middlewares/
│   ├── models/
│   ├── routes/
│   ├── services/
│   ├── utils/
│   └── validations/
├── package.json
└── README.md

Creating a New Module

To create a new module in your project:

npx apicraft create <moduleName>

Replace <moduleName> with the name of your module. For example:

npx apicraft create user-activity

This command generates:

• controllers/user-activity-controller.ts: Controller methods for handling API requests.
• dtos/user-activity-dto.ts: DTOs for validating input/output data.
• models/user-activity-model.ts: Mongoose model schema for MongoDB.
• routes/user-activity-route.ts: Express routes for module-specific endpoints.
• services/user-activity-service.ts: Business logic services for the module.
• validations/user-activity-validation.ts: Validation schemas for input data.

Global Error Handling

API Craft includes global error handling to ensure robustness and prevent server crashes. Errors are handled centrally, returning a consistent 500 Internal Server Error response with customizable error messages.

Templates

API Craft uses predefined templates located in the templates directory of the tool's installation. These templates can be customized to suit specific project requirements, promoting code consistency and readability.

Project Structure

The tool assumes the following directory structure within your project:

project-root/
├── src/
│   ├── configs/
│   ├── controllers/
│   ├── dtos/
│   ├── interfaces/
│   ├── mails/
│   ├── middlewares/
│   ├── models/
│   ├── routes/
│   ├── services/
│   ├── utils/
│   └── validations/
├── package.json
└── README.md

Contributing

Contributions to the API Craft CLI Tool are welcome! If you have any suggestions, improvements, or issues, please submit them to the GitHub repository.

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/your-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin feature/your-feature).
5. Submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About Me

I am an experienced Software Engineer, Security Researcher, and Hacker with a passion for creating robust and secure software solutions. With a track record of securing systems for renowned organizations, I bring expertise in enhancing digital security and developing innovative technologies.

Short Bio

Software Engineer 👩‍💻 | Security Researcher 📖 | Hacker 💻

Secured NASA, WHO, Paytm, Dell, Nokia, Lenovo, United Airlines, ABN AMRO Bank, and more.