DEV Community

Susheel kumar
Susheel kumar

Posted on

Introducing saksh-crud: Simplify Your Node.js CRUD Operations

We are thrilled to announce the release of saksh-crud, a powerful and flexible CRUD generator designed specifically for Node.js applications. Whether you're embarking on a new project or enhancing an existing one, saksh-crud is here to streamline your development process by automating the creation of CRUD routes.

Why Choose saksh-crud?

Creating CRUD (Create, Read, Update, Delete) operations is a fundamental task in web development, but it can often be repetitive and time-consuming. saksh-crud simplifies this process by generating the necessary routes based on your model files, allowing you to focus on building the features that truly matter.

Key Features

  • Automatic Route Generation: Effortlessly generate CRUD routes based on your model files.

  • Authentication Checks: Optionally include authentication checks in your routes for enhanced security.

  • Customizable Templates: Utilize default templates or provide your own custom templates for route generation.

  • Configuration File: Save your preferences in a configuration file for easy future use.

  • Event Emission: Listen to various events during the generation process and in the generated code for greater control and customization.

Getting Started

Getting started with saksh-crud is a breeze! Follow these simple steps:

  1. Install the Package via npm:
   npm install saksh-crud
Enter fullscreen mode Exit fullscreen mode
  1. Run the Script and follow the prompts to generate your CRUD routes:
   node saksh-crud.js
Enter fullscreen mode Exit fullscreen mode

Customization Options

saksh-crud offers extensive customization capabilities. You can create your own templates and specify them in the configuration file. The generator also emits events during the generation process and in the generated code, allowing you to hook into these events for custom actions.

Example Configuration

Hereโ€™s an example of a configuration file (saksh-crud.config.json):

{
  "defaultOutputDir": "./output",
  "includeAuth": true,
  "customTemplateDir": "./templates"
}
Enter fullscreen mode Exit fullscreen mode

Events

The CRUD generator emits several events during its execution, including:

  • beforeGenerate
  • afterGenerate
  • error

Additionally, the generated CRUD routes emit events such as:

  • beforeCreate
  • afterCreate
  • beforeUpdate
  • afterUpdate
  • beforeDelete
  • afterDelete

Contributing

We welcome contributions from the community! If you have ideas for new features or improvements, please open an issue or submit a pull request on our GitHub repository.

License

This project is licensed under the ISC License.


We hope saksh-crud helps you save time and effort in your Node.js projects. Happy coding! ๐Ÿš€

Top comments (0)