express-mysql-generator

0.0.9 • Public • Published

express-mysql-generator

express-mysql-generator is a simple CLI to generate APIs linked to a mySQL database.

To install and use it globally type "npm install express-mysql-generator -g".

now to create a new project just type "emg new <projectName>". A series of parameters will be asked such as the port to use for your api, the name of the database you want to create or use, etc.... a folder with the name of your project will be created, the sub-folder 'api' contains all the folders and source files of your new api.

this api is divided into modules, each module corresponds to a table of your database, you can add other elements later on. to add a new module once arrived in your api folder type "emg mo <moduleName>", after validating the fields your new module will be automatically added to the API. note: do not create "id" fields, this field is implemented by default in each module.

Each module has a route with endpoints for the CRUD: example myModule becomes:

  • /api/my-module/ to read all
  • /api/my-module/read/:id to read one
  • /api/my-module/create to create
  • /api/my-module/update/:id to update
  • /api/my-module/delete/:id to delete

important: when you create a project or a module the name of this one must not contain a space, preferably using the camelCase syntax.

The API has two startup scripts "dev" and "start". With "npm run dev" the api runs with nodemon which allows hot reloading. With "npm run start" launches the api with node in the classical way.

Remember the options:

  • "new" for a new project
  • "mo" to add a module

Hoping this tool will save your time. Have fun!

Readme

Keywords

none

Package Sidebar

Install

npm i express-mysql-generator

Weekly Downloads

1

Version

0.0.9

License

ISC

Unpacked Size

23.1 kB

Total Files

5

Last publish

Collaborators

  • slade850