DealDex

Table of Contents

1. DealDex
2. Features
3. Installation
4. Scripts
5. Diagrams
6. Future Goals
7. Meet the Team

Features

DealDex is a product lookup tool that can be used to compare similar products from different storefronts

1. Webscraping and APIs: DealDex intends to implement a mixture of webscrapers and free APIs to get relevent data from online storefronts.
2. Intuitive User Interface: DealDex is built with the user in mind! An intuitive search/filter box responds to user clicks and displays the filtered results.
3. Acorn: because who doesn't love a good 'ol acorn.

Installation

1. Ensure that you have the required prerequisites installed:

• npm

2. Fork the DealDex repository on your own GitHub account.
3. Clone your forked repository to your local machine.

git clone https://github.com/<your-github-username>/DealDex.git

4. Navigate to the root project directory and install dependencies

cd DealDex
npm install

5. Build the application in the client directory

npm run build

6. Run both the local server and development server

npm run startBoth

Scripts

• start: Starts the development server using Webpack
• npm run server: Starts a local server to preview the production build.
• npm run build: Runs Webpack in production mode to build your application for production.
• npm run startBoth: Starts a local server and the development server concurrently to test client-side requests to the server

Diagrams

Future Goals

• Webscrapers and APIs: We did not get around to configuring any webscrapers and there weren't any free offical APIs available from the storefronts we checked.
• More SQL Table Coverage: In our quest to present an MVP, we haphazardly combined SQL tables. In the future, we'd like if our SQL tables were properly modularized and linked via keys.
• Serverside Routing and Middleware: We would like to have more specific queries to our database so that we can get exactly what we need in the frontend. This way, we can both modularize our backend and have a clean and readable frontend!
• Frontend Functionality: Currently, our react app is built with react hooks. Because we are lacking in some middleware, we decided to scrap the functionality and build out a solid foundation aiming for modularity.
• Authorization and the Navigation Bar: Currently we have the login/signup skeleton created. We would like to add this feature to our navbar with some added funcionality such as search history and favorites.

Meet the Team

	Chang Moon GitHub LinkedIn
	Cortland Young GitHub LinkedIn
	Don Do GitHub
	Jun Lee GitHub LinkedIn
	Patrick Vuong GitHub LinkedIn
	Alan Back GitHub LinkedIn
	Jeremy Chen GitHub LinkedIn
	Josh Goo GitHub LinkedIn
	Trey Walker GitHub LinkedIn