Giter Club home page Giter Club logo

bamazon-nodejs-mysql's Introduction

Bamazon Node.JS and MySQL application

  • Created: Saturday, April 28th, 2018

  • Context: This is the twelfth week's homework assignment as a part of the Georgia Tech Coding Bootcamp. In this assignment, we are building a NodeJS based application with MySQL for database management and with interactive prompts (through the Inquirer NPM package). The homework's high level instructions are as follows:

In this activity, you'll be creating an Amazon-like storefront with the MySQL skills you learned this week. The app will take in orders from customers and deplete stock from the store's salesByDeptArray. As a bonus task, you can program your app to track product sales across your store's departments and then provide a summary of the highest-grossing departments in the store.
  • See a quick walk-through demonstration of the application for the different experiences via:
    • BamazonCustomer_Walkthrough.webm
    • BamazonManager_Walkthrough.webm

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.

* You'll need to have NodeJS installed on your computer since this application has no wep-page front-end
* This application also will require the following:
    * https://www.npmjs.com/package/inquirer
    * https://www.npmjs.com/package/mysql
    * https://www.npmjs.com/package/cli-table
    
* There are no APIs used in this application so there are no additional setup instructions regarding credential management
* Standard behavior of "npm install" should apply given the provided package.json details

Prerequisites

These are things you need to install the software and how to install them:

see 'Getting Started' section above

Installing

These are a set of step-by-step series of examples that tell you have to get a development env running:

1.) Install NodeJS & some MySQL editor (such as MySQL Workbench)
2.) Clone Git repository
3.) Run 'npm install' from local git directory
4.) Run the file by command based on the user type experience you'd like to experience:
        a.) Customer Experience: bamazonCustomer.js
        b.) Manager Experience: bamazonManager.js
        c.) Supervisor Experience: bamazonSupervisor.js
5.) Try out the application and enjoy!

Running the unit-level tests

These are the details of how to run the automated tests for this system:

Not Applicable

End-to-end tests

These are the details of what these tests test and why:

Not Applicable

And coding style tests

This is where you will find details outlining the approach and coding style in terms of what these tests test and why

Not Applicable

Deployment

Additional notes about how to deploy this on a live system can be found here:

Not Deployed as this is a NodeJS Application for testing purposes

Built With

  • Webstorm (Version: 2018.1) - Generation of HTML and CSS

Contributing

  • Geoff Goodwin (self) - Author

Versioning

  • version 1.0 - Initialization of project
  • version 2.0 - Updated logic for all three experiences

Authors

License

details TBD

Acknowledgments

  • Appreciation to PurpleBooth for initial Readme-Template

bamazon-nodejs-mysql's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.