1.0.5 • Published 4 years ago

@abduldewaswala/onboardingmodule v1.0.5

Weekly downloads
-
License
MIT
Repository
-
Last release
4 years ago

Onboarding Modules

Requirements

  1. Node 10.* +
  2. NPM 5.* +

Download and install node from https://nodejs.org/en/

How to Install modules

Install all required node modules

To use this modules copy all the folder to your project folder.

Open terminal and go to your projet folder.

For example if you are of Linix operating system.

type : cd /opt/lampp/htdocs/<project-flder>

if you are of Windows operating system.

type : cd xampp/htdocs/<project-folder>

Now run the following command in the terminal

type : npm i or npm install

Now wait for process to complete. This will Install all the required node modules necessary to use Onboarding modules.


Setting modules for your project

To use these modules we need to change some of the files to set as or project requirements.

  1. Select unique server port for every new projects
    • Go to server.js file in the root of the module on the third line change to port number to any other value.
    • Port value of every project should be unique, otherwise the node server will not work
  2. Change config values
    • Open config file in config/config.js
    • Change email addrees for smtp mail to your desired email id
    • Change password to the respected email id
    • Change base url to http://localhost:<project-port>/ and http://<project-ip>:<project-port>/
  3. Change Appconfig
    • Open appconfig file in constant/appconfig
    • change database credential to match your project

Note : The mail system is commented so the project dont send message every time to start using mail uncomment the function in model/nodemailer.js


Start node server

To start node server , open terminal, go to your project

For example if you are of Linix operating system.

type : cd /opt/lampp/htdocs/<project-flder>

if you are of Windows operating system.

type : cd xampp/htdocs/<project-folder>

create database in phpmyadmin

Open database.json in root folder and update all the data required

Now run the following command in the terminal

npm run m or db-migrate up database.json

Note : this will create table users in your database

npm run d or nodemon server

Note : this will start server after every change on the server file.

npm run p or node server

Note : You have to manually restart server. To do so click ctrl + c and start server again.