xpress-architect v0.0.3

xpress-architect

xpress-architect is a simple CLI to generate APIs with a modular architecture.

To install and use it globally type "npm install xpress-architect -g".

now to create a new project just type "xarch new \<projectName>". 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.

it includes swagger with an easily editable swagger_config.json file

this api is divided into modules, each with its own routes, controller, service and query files, you can add other elements later on. to add a new module once arrived in your api folder type "xarch mo \<moduleName>", after validating new module will be automatically added to the API and the swagger will be updated.

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

• /my-module/ to read all (get)
• /my-module/read/:id to read one (get)
• /my-module/create to create (post)
• /my-module/update/:id to update (put)
• /my-module/delete/:id to delete (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!