BAMazon is a command line application created with NodeJS and MySQL. There three separate programs included in this project. Each program is designed for a different BAMazon user, one for customers, one for managers, and one for supervisors. Data about the store's inventory is stored in a local MySQL database which can be recreated by any user with the provided sql files in this project.
Watch this video demo of how to use this application.
The following is a getting started guide for running BAMazon on your local machine.
- NodeJS - NodeJS is required for running the javascript for this application.
- MySQL - Required for the local database instance.
Download the zip file from this repo or fork this repo to get the code on your computer.
Once the code is installed on your computer navigate to root of the project in a bash/terminal/command prompt of your choice. Run the following node command to install the required dependencies.
$ npm install
A local database is required for storing product and department information for BAMazon. Here are the steps for setting up a basic database to get going.
- Start MySQL server on your computer.
- Execute the queries found in the bamazon.sql file to create the bamazon database and products table.
- Execute the queries found in the departments.sql file to create the departments table.
In the root of the project create a .env file. Use the example.env file included in the project as an example for how to set up the local .env file. Enter the database credentials for the host, port, user, and password values.
To run BAMazon execute the following command in the bash/terminal/command prompt of your choice in the root of the project directory.
- For BAMazon customer program run
$ node bamazonCustomer.js
- For BAMazon manager program run
$ node bamazonManager.js
- For BAMazon supervisor program run
$ node bamazonSupervisor.js
BAMazon was built with the following technologies.
- NodeJS
- NPM
- MySQL
- mysql npm module
- Inquirer npm module
- Dot-env npm module
- console.table npm module