Student Loop - Server

This is the server used by the Service Loop app. I built the server architecture with a 3-tier achitecture design in mind.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

1.) npm
2.) NodeJS
3.) Windows-Build-Tools (Optional if not getting 'gyp ERR!' when installing the node_modules)

Installing

A step by step series of examples that tell you how to get a development env running

1.) Download or pull the repository

git pull origin master

2.) Install all node_modules by running the below command in the folder in which you pulled the repository

npm install

3.) In the node_modules folder, find the 'ringcaptcha-nodejs' module and in the lib folder open 'ringcaptcha.js'. In this file, change the below code on line 48 to this.

Change this:

form: {app_key: this.app_key, phone: mobile, api_key: this.api_key, code: this.code, token: data.token}};

To this:

form: {app_key: this.app_key, phone: mobile, api_key: this.api_key, code: data.code, token: data.token}};

The reason for doing this is that module being used to implement the SMS verification code functionality has an error where when trying to verify a code, the module sets the code to undefined

4.) In the 'index.js' file, we need to change to what port and IP address does the express server listen to.

Change this:

let localhost = false;

To this:

let localhost = true;

5.) In the 'services' folder, find 'functions.js' and change the login credentials

Change this:

host: 'smtp.sendgrid.net',
        port: 465,
        secure: true,
        auth: {
            user: '',
            pass: ''
        }

To this:

host: 'smtp.gmail.com',
        port: 465,
        secure: true,
        auth: {
            user: YOUR GMAIL,
            pass: YOU GMAIL PASSWORD
        }

6.) And finally, launch the server!

node index.js

Running the tests

For automated unit testing we are using Jasmine. To run the tests automatically, run the below command.

npm test

Deployment

To deploy the server to the live enviornment follow the below steps:

1.) In the 'index.js' file, we need to change to what port and IP address does the express server listen to.

Change this:

let localhost = true;

To this:

let localhost = false;

3.) In the 'services' folder, find the 'functions.js' file, change the smtp details to our sendgrid details.

4.) Upload the server WITHOUT the node_modules to the server

Built With

• Node.js - The server framework used
• Express - The web framework used with Node.js
• MongoDB - Our database
• Mongoose - This is our Object Data Modeling (ODM) library for MongoDB and Node.js

Authors

• Nichita Postolachi - System Architecture and Solution Design - D0019208

License

This project is licensed under the MIT License - see the LICENSE.md file for details