node-architecture-starter

Nodejs design architecture that you can reuse to avoid redundant work

Installation

Inside your project directory:

sudo npm install node-architecture-starter --save

Usage

1. Create a file where you have your package.js file; and name it generate.js

sudo touch generate.js

2. Inside generate.js write and save the following line:

const ns = require('node-architecture-starter');

3. Execute the following command on your terminal:

node generate

4. Specify your project name when prompted. Note: Your project name should be the same as your root directory.
5. Type Y when prompted to Create directories (data, models, controllers, routes, test). Choose Y/N:
6. Next, provide an entity name (All small letters) when prompted to Current project (testProject2), Enter entity name (Data model):. Note: entity name is a name of a table in your database.
7. You should see a list of successful messages displayed as shown below:

• _If everything is successfully, you can exit the console (Ctrl + C)
• _File permission change successful
• _File permission change successful
• _File permission change successful
• _File permission change successful
• _File permission change successful
• _File content replacement successful
• _File content replacement successful
• _File content replacement successful
• _File content replacement successful
• _File content replacement successful

8. As a result of action 5, your project should appear as shown below. _Items in block are the recent generated directories:

• _controllers
• _models
• _routes
• _data
• _test
• _node_modules
• _generate.js
• _package-lock.json
• _package.json

9. As a result of action 6, in each of the following directories (controllers, models, routes, data, test), you should find a file named as entity name you provided with prewritten nodejs code.

10. At this point you are done. You can now continue working on your project.