Skip to content

CS178A-B/final-project-circularly-dependent

Repository files navigation

Capitalizer

An intuitive spending analysist

Table of Contents

Overview

Our application is engineered to help your city efficiently allocate taxpayer dollars. We do this by automating the tracking and analysis of your city's previous spending records so they can better manage their spending.

This app is made up of five primary modules:

  • Web Client (powered by React.js)
  • Server (powered by Node.js & Express.js)
  • Natural Language Processing (powered by Java & Standford's CoreNLP library)
  • Database (powered by MySQL)
  • Dashboard (powered by the ELK Stack - ElasticSearch, Logstash, & Kibana)

Our web client is the view of our whole system, this is how you upload your data and analyze it with any of our convienient tools. Our dashboard is housed inside of our web client, but is generated by Kibana which runs on the ElasticSearch (ES) engine. Before your data is displayed on our interactive dashboard, additional information needs to be extracted and processed; that's where our natural language processing (NLP) comes in. Our NLP module takes your uploaded data and extracts the right information so that you can view your data much more clearly. However, the NLP app needs to get this data from somewhere: our server. This is the muscle that allows all our modules to communicate; it's also responsible for maintaining our database. Our database is where all the spending & user data is safely stored. It's also the source where the ES engine uses Logstash to help it ingest the processed data and display it on our Kibana powered dashboard.

With this application, you can upload a csv document containing your city's spending data and immediately understand spending trends. You can use our interactive dashboard to break down your data by product, department, vendor, date, and much more. You can even compare your city's spending history with another city. Scroll down to meet our team of developers, and keep going so you can see how our app works.

Team

Nathan Brennan

Jason Chan

Siena Seung Eun Ha

Usage

Demo

Natural Language Processing Web Client
NLP demo Web app demo

Screenshots of Application

Alt text

First thing you do is authenticate
image image
View our interactive dashboard powered by Kibana

image

Break down spending data by department, vendor, product, or all three
image image
image image
Upload your spending data & analyze with our other tools
Alt text Alt text
Alt text Alt text
About us

image

How To Run

Server:

May need to configure MySQL first.
If this step is needed, run the following commands:
ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'CS178!CD!dc';
FLUSH PRIVILEGES;
set global net_buffer_length=1000000;
set global max_allowed_packet=1000000000;

This will downgrade MySQL authentication to match with NodeJS.

In the project directory, you can satisfy dependencies with:

npm install

To run server in development mode:

npm start

Logging will be on the console you ran from.
Server will be listening on http://localhost:4000.

Server will restart if you make edits.
You will also see any lint errors in the console.

Client:

Start new terminal, seperate from the server.
In the project directory, change to client directory:

cd deep-capitalizer

You can satisfy dependencies with:

npm install

To run client in development mode:

npm start

Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Diagrams

High Level Pipeline

Alt text

Sequence of Pipeline in detail

image

Dependencies

Install Node Package Manager (npm). Helpful NPM Documentation

Install Java. Download Java here

Install MySQL. Download MySQL here