Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 1.87 KB

README.md

File metadata and controls

66 lines (43 loc) · 1.87 KB
Raw

Fincensus

A visualization tool for consumer opinion on financial products built with the MERN stack: MySQL, Express, React/Redux, Node

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Tasks
    3. Launching App
  4. Team
  5. Roadmap
  6. Contributing

Usage

Fincensus was developed to visually inform the public of trends in complaints by U.S. citizens on financial products. This is accomplished by providing a visualization of registered U.S. Census and Consumer Complaints data sources.

Requirements

Make sure you have installed all of the following prerequisites on your development machine:

  • Node 4.4.5
  • Express 4.13.4
  • React 15.0.2
  • Redux 3.5.2
  • Sequelize 3.22.0
  • MySQL 2.10.x

Development

Installing Dependencies

From within the root directory:

npm install

Build Tasks

To build the project from within the root directory from a bash CLI:

npm test
npm run build
npm run dev

This series of commands will run the mocha suite test, build the client files, and serve the client files to http://localhost:3333, respectively.

Note: client/test/ will be ignored in build

Team

  • Nicolas Vinson

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.