crud-app-generator v0.5.0

CRUD API Generator

Description

npx crud-app-generator is a command-line tool to generate CRUD (Create, Read, Update, Delete) operations for MongoDB collections with Node.js in Express.js.

crud-app-generator

Installation

You can install crud-app-generator via npm:

npm install -g crud-app-generator

Usage

npx crud-app-generator [projectName] [options]

Options

• [projectName]: Optional argument representing the name of the project. Default project name would be "my-node-app".
• -m, --mongo-url <mongo-url>: Mongo URL String. Specifies the URL for connecting to the MongoDB database.
• -c, --collection <collection-name>: Mongo Collection Name (lowercase & singular). Specifies the name of the MongoDB collection. Default value is "todo".
• -s, --schema <schema-key-types>: Mongo Collection's Schema. Specifies the schema of the MongoDB collection in the format {"key": "Type"}. Example: "{\"myKey\": \"String\"}".
• -p, --port <node port>: Node Server Port. Specifies the port for the Node.js server. Default value would be 3000.
• -h, --help: Display help for command. Displays usage information for the crud-app-generator command.

Examples

Generate CRUD operations for a MongoDB collection named "tasks" with a custom schema:

npx crud-app-generator myProject -m mongodb://localhost:27017/mydb -c task -s "{\"title\": \"String\", \"description\": \"String\"}" -p 4000

This command generates CRUD API code for a project named "myProject" which will get connected to a MongoDB database located at mongodb://localhost:27017/mydb, "task" collection will get created with a schema containing "title" and "description" fields. And the Node.js server will run on port 4000.

Project Setup

To Run the Project

cd myProject
npm install
npm run dev

To Run Unit Test of the Project

cd myProject
npm install
npm run test

You can open http://localhost:4000/ to see the API details

Help

For more information on using crud-app-generator, run:

npx crud-app-generator -h