wwwillchen / scheming-lion

A full-stack web application that integrates the Hacker News API to provide a dashboard for data analysis and visualizations.

Hacker News Dashboard

The Hacker News Dashboard is a full-stack web application which utilizes the Hacker News API to provide a dashboard for data analysis and visualization.

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Our project is split into two repositories. (1) Scraper is the code we used to scrape all the data from the HN API and place it into text files. (2) Scheming-Lion is the general repository that structures our site, queries, features, and inserts the data into our MySQL database using the Sequelize ORM.

Our tech stack

Our project uses Angular, Node, a MySql Database for the backend, and the Sequelize ORM.

Navigating the file structure

• Client - all client facing code. Contains our primary features - Track Posts, track users, see user's top stories, word frequency visualizations.
• Server - contains (1) a set of query helper functions for easily using the Database (2) a database folder, which contains our code for inserting new data into our database, and (3) a generic server setup for local development (which you most likely will not use now that we have fully populated the database and have it deployed using Azure)
• Testing - We have some basic testing built out for the front-end code. The backend code is not rigorously tested because that would require read/write access to HN's own database, but we have tested this informally and have confirmed that all datapoints exist.

Requirements

• Node 0.10.32
• Express ~4.9.0
• MySQL ?
• Angular ~1.2.18
• etc

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.