The O.V.E.N.

Order Verification and Export Network

What is it?

The O.V.E.N is a modern web application built for Breadsmith MN to better organize their commercial business orders.

The application is accessed through either the customer portal or the administrator portal. Users must authenticate using an email address that supports Google OAuth, which must be registered in the application database as either a customer contact or an administrator (both added by an existing administrator).

The application seeks to:

• Provide a simple and customized customer portal for Breadsmith's commercial clients to place their own orders before 2 P.M.
• Allow Breadsmith's administrators to:
  • Maintain customer, product, and order data
  • Customize the products available to each customer
  • Customize product pricing for multiple product variations
  • Maintain standing orders by day of the week that are generated without requiring customer input
  • Interface with the rest of their production pipeline by aggregating order data for daily production in CSV form and allowing the team to print picking and packing lists

---

Build

Requirements

The O.V.E.N. requires a version of Node.js that supports ES6 promises and arrow function syntax and a database that supports SQL. It was developed and tested on Node.js version 7.4.0 and PostgreSQL version 9.6.1. The front end of the application was tested on Google Chrome version 56 and Safari version 10.0.2.

Installation instructions:

1. git clone or download the repository
2. npm install to get dependencies
3. npm postinstall to create database tables. A DATABASE_URL environment variable pointing to the desired database is required
4. Additional environment variables required are:
   • FIREBASE_PROJECT_ID, FIREBASE_PRIVATE_KEY, FIREBASE_CLIENT_EMAIL for Firebase authentication
     • These can be found in the Firebase console (http://firebase.google.com). You will need to create a Firebase app to use these.
     • You can also get a new config.js specifically for your Firebase app and place it in public/scripts/
   • MAIL_SERVICE (e.g. 'gmail'), MAIL_USER, MAIL_PASS to send emails
5. npm start to run the app on port 3000 or the environment variable PORT if present

• NOTE: The server must be running to generate automatic orders. By default this happens at 9 A.M. each day.

---

Customization:

Certain configurations are contained in the code:

• To change the times that order warnings are displayed to the customer, see:
  • line 53 ($scope.onTimeOrder)
  • line 57 ($scope.callForOrder)
  • line 61 ($scope.placeForTomorrow)
  • in public/scripts/controllers/customerController.js
• To change the time when automatic orders are generated, see:
  • line 111 (function scheduleOrders) in server/lib/autoOrderLib.js

---

Technologies Used:

• AngularJS
• Node.js
• Express.js
• PostgreSQL
• Firebase
• Bootstrap

Additional Dependencies:

• Knex.js
• Moment.js
• json2csv
• Papa Parse
• Nodemailer
• Node Schedule