Skip to content

How to use

Traceton Timmerman edited this page Nov 19, 2021 · 2 revisions

How to use node-trekker

Before running any node-trekker commands, you must start node-trekker from the terminal(while being inside of your apps directory)

npm run node-trekker

You can now enter any of the available commands below

help - Gives your versions readme and commands available with your version of node-trekker

exit - Exits the node-trekker script

Currently 3 data-types are available, :String :File and :Image

❗ If :Image or :File will be used, make sure you followed the install correctly in this wiki's install and setup section, also you'll need to send multipart/form data from the client side ❗

❗ New files will not overwrite existing ones ❗

Generate a mongoose model

Format : generate model model-name field-name:data-type field-name:data-type

Example: generate model blogPost mainTitle:String description:String

Short Hand Example: g m blogPost mainTitle:String description:String

Generate a express router

Format : generate router router-name field-name:data-type field-name:data-type

Example: generate router blogPost mainTitle:String description:String

Short Hand Example: g r blogPost mainTitle:String description:String

Generate a empty express router

Format : generate empty-router model-name

Example: generate empty-router blogPost

Short Hand Example: g e-r blogPost

Generate a .rest file

Format : generate tests router-name field-name:data-type field-name:data-type

Example: generate tests blogPost mainTitle:String description:String

Short Hand Example: g t blogPost mainTitle:String description:String

Generate a router with a model

Format : generate router-with-model model-name field-name:data-type field-name:data-type

Example: generate router-with-model blogPost mainTitle:String description:String

Short Hand Example: g rwm blogPost mainTitle:String description:String

Generate a server.js, router, model, and .rest file.

Format : generate crud model-name field-name:data-type field-name:data-type

Example: generate crud blogPost mainTitle:String description:String

Generate a empty express server with .env file

Example: generate empty-server