prudradeep / crudsify

CRUDSIFY - A Simplified RESTful API generator
MIT License
0 stars 0 forks source link
CRUDSIFY - A Simplified RESTful API generator


Introduction

Welcom to Crudsify! the npm package that revolutionizes CRUD operations in web development! With Crudsify, you can effortlessly handle Create, Read, Update, and Delete operations in your Node.js applications.

Gone are the days of manual endpoint creation and repetitive coding. Crudsify leverages the power of Express.js and Sequelize.js to generate REST API endpoints with just a few simple commands. Whether you're building a small-scale application or a large-scale project, Crudsify scales with you, providing a seamless experience throughout.

What sets Crudsify apart is its user-friendly interface and extensive customization options. You can easily configure your models, routes, and controllers to match your application's unique needs. Plus, Crudsify's robust error handling ensures smooth operation even in complex scenarios.

Join the growing community of developers who rely on Crudsify for efficient CRUD functionality. Install Crudsify today and unlock the full potential of your Node.js applications!

Why use Crudsify?

There are several compelling reasons to use Crudsify for handling CRUD operations in your Node.js applications:

  1. Efficiency: Crudsify significantly reduces development time by automating the generation of CRUD endpoints. You no longer need to write repetitive code for basic CRUD functionality, allowing you to focus on building core features of your application.

  2. Simplicity: With Crudsify's intuitive commands and configuration options, creating, reading, updating, and deleting data becomes a straightforward process. This simplicity is especially beneficial for developers new to backend development or those looking to streamline their workflow.

  3. Consistency: By using Crudsify, you ensure a consistent structure and format for your API endpoints across different models and entities. This consistency leads to better maintainability and easier collaboration among team members.

  4. Customization: While Crudsify automates the basic CRUD operations, it also offers extensive customization options. You can tailor the generated endpoints, models, routes, and controllers to meet your specific application requirements, giving you the flexibility you need.

  5. Error Handling: Crudsify comes with robust error handling mechanisms, helping you manage exceptions and edge cases effectively. This ensures the reliability and stability of your API endpoints even under challenging scenarios.

  6. Scalability: Whether you're working on a small project or a large-scale application, Crudsify scales with your needs. It adapts to the complexity and size of your data models, providing consistent performance and reliability.

Overall, Crudsify empowers developers to build robust and scalable Node.js applications with minimal effort, making it a valuable tool for modern web development workflows.

Features


Requirements

You need Node JS >= 18 installed. You should have a basic knowledge of Sequelize & Sequelize Migrations.

Installation

In project root directory, run following command:

npm install https://github.com/prudradeep/crudsify.git

Initiate

To initiate a Crudsify run following command:

For windows

node_modules/.bin/crudsify-cli.cmd init

For others

node_modules/.bin/crudsify-cli init

Rename .env.sample to .env and update environment variables.

NOTE: If you are using other than mysql dialect please install that driver as required by Sequelize. Check Sequelize documentation

Run API server

You can then run

node index.js

Documentation

Check out the docs on the Official site!

Contributing

We welcome contributions to Crudsify! These are the many ways you can help:

Please read our contribution guide to get started. Also note that this project is released with a Contributor Code of Conduct, please make sure to review and follow it.

Questions?

If you have any questions/issues/feature requests, please feel free to open an issue. We'd love to hear from you!

Support

Like this project? Please star it!

License

Crudsify is licensed under a MIT License.