1. Install NodeJS and MongoDB for your OS
2. Run MongoDB: e.g. mongod --dbpath=./data.
3. Clone repo and cd in.
4. Get address validation API key from SmartyStreets (free)
5. Create a .env file in root folder, store AUTH_ID and AUTH_TOKEN from SmartyStreet inside and save file.
6. Install Dependencies: npm install.
7. Start Server: npm start.

• URL: /api/product
• Method: GET
• URL Params: none
• Data Params: none
• Response:
  • Code: 200
  • Content: [{"_id": "PRODUCT_ID","name": "product1","description": "product1","value": 1,"__v": 0}]
• Example: curl -X GET http://138.68.46.47/api/product

• URL: /api/product
• Method: GET
• URL Params:
  • id : Number
• Data Params: none
• Response:
  • Code: 200
  • Content: {"_id":"PRODUCT_ID","name":"p1","value":1,"__v":0}
• Example: curl -X GET http://138.68.46.47/api/product/REPLACE_WITH_PRODUCT_ID

• URL: /api/product

• Method: POST

• URL Params: none

• Data Params:

  Required

  • name: String
  • value: Number

  Optional

  • description: String
  • width: Number
  • length: Number
  • height: Number
  • weight: Number

• Response:

  • Code: 200
  • Content: created

• Example: curl -X POST -H "Accept: Application/json" -H "Content-Type: application/json" http://138.68.46.47/api/product -d '{"name":"Product 100","value":"1"}'

• URL: /api/product

• Method: PUT

• URL Params:

  • id : Number

• Data Params:

  Required

  • name: String
  • value: Number
  • description: String
  • width: Number
  • length: Number
  • height: Number
  • weight: Number

• Response:

  • Code: 200
  • Content: updated

• Example: curl -X PUT -H "Accept: Application/json" -H "Content-Type: application/json" http://138.68.46.47/api/product/REPLACE_WITH_PRODUCT_ID -d '{"name":"Product 2","value":"1","description":"p1","width":"","height":"","length":"","weight":""}'

• URL: /api/product
• Method: DELETE
• URL Params:
  • id : Number
• Data Params: none
• Success Response:
  • Code: 200
  • Content: deleted
• Example: curl -X DELETE http://138.68.46.47/api/product/REPLACE_WITH_PRODUCT_ID

• URL: /api/order
• Method: GET
• URL Params: none
• Data Params: none
• Response:
  • Code: 200
  • Content: [{"_id":"ORDER_ID","recipientName":"Joey","streetAddress":"1269 Poplar Ave","city":"Sunnyvale","state":"CA","zipCode":"94086","phoneNumber":"4158192749","quantity":3,"product":"PRODUCT_ID","__v":0}]
• Example: curl -X GET http://138.68.46.47/api/order

• URL: /api/order
• Method: GET
• URL Params:
  • id : Number
• Data Params: none
• Response:
  • Code: 200
  • Content: {"_id":"ORDER_ID","recipientName":"Joey","streetAddress":"1269 Poplar Ave","city":"Sunnyvale","state":"CA","zipCode":"94086","phoneNumber":"4158192749","quantity":3,"product":"PRODUCT_ID","__v":0}
• Example: curl -X GET http://138.68.46.47/api/order/REPLACE_WITH_ORDER_ID

• URL: /api/order

• Method: POST

• URL Params: none

• Data Params:

  Required

  • recipientName: String
  • streetAddress: Number
  • city: String
  • state: Number
  • zipCode: Number
  • phoneNumber: Number
  • product: Number
  • quantity: objectId

• Response:

  • Code: 200
  • Content: created

• Example: curl -X POST -H "Accept: Application/json" -H "Content-Type: application/json" http://138.68.46.47/api/order -d '{"recipientName":"Alex", "streetAddress":"1269 Poplar Ave", "city":"Sunnyvale", "state":"CA", "zipCode":"94086", "phoneNumber":"123456789", "product":"REPLACE_WITH_PRODUCT_ID", "quantity":"1"}'

• URL: /api/order

• Method: PUT

• URL Params:

  • id : Number

• Data Params:

  Required

  • recipientName: String
  • streetAddress: Number
  • city: String
  • state: Number
  • zipCode: Number
  • phoneNumber: Number
  • product: Number
  • quantity: objectId

• Response:

  • Code: 200
  • Content: updated

• Example: curl -X PUT -H "Accept: Application/json" -H "Content-Type: application/json" http://138.68.46.47/api/order/REPLACE_WITH_ORDER_ID -d '{"recipientName":"Alex", "streetAddress":"1269 Poplar Ave", "city":"Sunnyvale", "state":"CA", "zipCode":"94086", "phoneNumber":"123456789", "product":"REPLACE_WITH_PRODUCT_ID", "quantity":"1"}'

• URL: /api/order
• Method: DELETE
• URL Params:
  • id : Number
• Data Params: none
• Success Response:
  • Code: 200
  • Content: deleted
• Example: curl -X DELETE -H http://138.68.46.47/api/order/REPLACE_WITH_ORDER_ID

npm test will run end-to-end tests. (To be done)

• Address Validation is done with SmartyStreets API.
• Tech Stack is MEAN.
• Bootstrap for UI.
• Mongoose as middle layer between UI & DB.
• Yahoo Finance API & AngularJS Doc for currency exchange.
• Modified MEAN.io boilerplate

Copyright 2017, Alex Yao

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.