Getting Started:
Check out the project (follow Github instructions) in the project directory: (1) npm install (2) bower install (3) set environment variables (Ask scott for the variables) a) AWS b) Cloudant c) SendGrid d) Stripe (4) ways to run a) node server.js //this runs the whole app at localhost:8080 and it connects to all of the databases. It communicates with the server with http. Use this most of the time. The only thing that you can't do with this is test stripe because it's an unsecure library. b) node server.js https //this runs the whole app at https://localhost:8443 and it connects to all of the databases. It communicates with the server with https so it's good for testing stripe. The only problem is that it uses a self-signed certificate so looks sketchy. c) grunt serve //if you don't have an internet connection and are only doing front end bugs, this is the way to go. The system won't connect to any databases or anything remote.
We have two databases. The real database is called intelliwheels. The database for testing is called intelliwheels-testing. line 22 of userController.js has the _designFunctionID for the real database. The testing database has a special handler that redirects it when you use it.
##Notes on backup scripts Backup script should automatically run daily at night. restore scripts need to be run manually like this: a) node restore.js 2016-10-27 - to restore all databases to October, 27, 2016 b) node restoreIndividual.js 2016-10-27 di@intelliwheels_development.com - to restore di@intelliwheels_development.com user and orders data to October, 27, 2016 In order for backup and restore scripts to work, next environment variables need to be configured: a) AWS_ACCESS_KEY_ID b) AWS_SECRET_ACCESS_KEY c) BACKUP_BUCKET - S3 bucket to store backups d) BACKUP_DB_LOGIN - Cloudant DB login e) BACKUP_DB_PASSWORD - Cloudant DB password f) BACKUP_ALARM_EMAIL - e-mail to receive notification on errors, such as starting server with lack of parameters or when receiving invalid JSON on database backup g) SENDGRID_API_KEY
loadash (with the symbol _.) is used for array, and object manipulation. details see:https://lodash.com/
docs are available in the docs folder
ECMAScript 6 are being used here like '=>' make sure to turn on ECMAScript 6 interpreter in your IDE. Otherwise it will be considered as syntax error.
The server side code is no longer under one long server.js script.
It has now been split up into seperate files inside the server_scripts directory.
This directory holds all the custom server endpoints. Each endpoint is clustered according to their functionality.
For instance, all login,logout,registration, and session endpoints are under server_scripts/routes/authController.js.
Each of the files under server_scripts/routes expose an instance of an express.Router(). These routers are then all merged into a central router in server_scripts/routes/index.js which is then used in the server.js script.
To add a new endpoint, either add the endpoint to an existing script in server_scripts/routes or create a new controller script under the same directory. If you create a new controller, it will automatically be found by server_scripts/routes/index.js and included when the server is launched.
This directory contains all middleware policies. These are small checks that happen before a request gets sent to its designated request handler. To use them, just import them with require wherever you want them to be referenced.
Services are fairly generic. Anytime you want to define a function or expose a variable that needs to be referenced in multiple places, expose it in a file under server_scripts/services and then import it with require wherever you need it.
After writing or altering CSS, make sure to run npm run autoprefixer in order to have style prefixes required for different browsers.
To run the tests for this project, just run npm test
To run just tests for the backend, run npm run test_backend
To run just tests for the frontend, run npm run test_frontend
Backend tests are written with the Mocha test runner. In addition to this, the tests also use supertest for interacting with the backend, and Should for assertions.
Guide to install ssl certificates is at: http://www.joshwright.com/tips/setup-a-godaddy-ssl-certificate-on-heroku Godaddy provides a standard SSL certificate, and we have our files stored in Abacus-mvp/certs