avishaan/quippics

ExpressJS, Mongoose, Node, Passport, Image voting ranking rating backend API.

quipics

ExpressJS, Mongoose, Node, Passport, Image voting ranking rating backend API.

The following is a general backend method to upload, rank, score, and comment on submissions to a challenge.

Technology/Players

• Express as the web application framework.
• Node.js as the server platform.
• Passport as the authentication middleware.
• Jasmine as the testing framework.
• Mongoose as the object modeler for Node.js.
• MongoDB as the x-platform document based noSQL database.
• Istanbul as the code coverage assessment tool

Domains

Each environment is found at a different route. This is to allow fast development without disturbing production. The environments are as such in the following table.

Env Type	Domain	Description
Dev	quippics-dev.herokuapp.com	Should be used to develop the latest version of the app
	dev.quippics.us (preferred)
Test	quippics-test.herokuapp.com	Should be used for beta testing. Bugs should be fixed to prepare for prod
	test.quippics.us (preferred)
Prod	quippics-prod.herokuapp.com	Should be used for production environment. Only changes at this point are for bug fixes
(Master)	prod.quippics.us (preferred)

Documentation

Each route takes the format of domain/version/route The route is located in the route documentation. The version differences are specified in each route. Route Example: dev.quippics.us/api/v1/register

• Code Coverage(via Istanbul)

  • Code Coverage Reports

• Route Documentation

  • Information on Challenge Routes
  • Information on Submission Routes
  • Information on User Routes
  • Information on Friendship Routes
  • Information on Ballot Routes
  • Information on Comment Routes
  • Information on Activity Routes
  • Information on Follow Routes
  • Information on Apple Notifications Routes

• Connecting Routes to Interface (Right Click and Save-As)

Test Cases

Test cases are bundled into logical groups