GithubHelp home page GithubHelp logo

leonardomathon / interactive-world-happiness-visualization Goto Github PK

View Code? Open in Web Editor NEW
6.0 1.0 2.0 860 KB

An interactive web application that aims to clearify the world happiness ranking among countries by combinding the world happiness data from the year 2015 up and including 2020, with easy to use and understandable charts and maps built with D3 and THREE.js.

Home Page: https://world-happiness.leonardomathon.nl

Python 4.84% Jupyter Notebook 17.49% JavaScript 65.65% CSS 4.57% EJS 7.44%
world happiness-report visual-studio threejs d3 javascript

interactive-world-happiness-visualization's Introduction

๐ŸŒ Interactive World Happiness Visualization

The World Happiness Report is a landmark survey of the state of global happiness, including over 150 countries. Every year, a new report is published that gives countries a happiness ranking based on a number of factors. However, the report consists over 200 pages and can for some readers be unclear.

This interactive web application aims to clearify the world happiness ranking among countries by combinding the world happiness data from the year 2015 up and including 2020, with easy to use and understandable charts and maps built with D3 and THREE.js.

Live link

Table of contents

  1. Installation
    โ€‚Install system dependencies โ€‚Install dependencies โ€‚Run project
  2. Usage
  3. Technologies used
  4. Acknowledgments

๐Ÿ”ง Installation

The following instructions walks you through the installation process. For this installation process, it is assumed you have basic experience with a terminal or the windows command prompt.

Install via releases

Installing the application is as simple as downloading the latest release and unzipping the files in a directory of choice. You can now run the index.html in your preferred browser.

Installing system dependecies

You can also build the project yourself. The following steps will walk you through this process.

Node.js

In order to run this project, you must have Node.js installed. We recommend installing the long time support version of Node, v14.15.x, since previous Node versions might not work.

You can check your if Node is succesfully installed by running the command node -v inside a terminal window or command prompt.

NPM

To install the required packages, use must ensure that you have NPM installed. NPM comes typically bundled with Node, meaning once Node.js is installed, NPM will also be installed.

You can check your if NPM is succesfully installed by running the command npm -v inside a terminal window or command prompt.

Installing dependencies

Clone the repo

You can clone the repo with the command git clone https://github.com/leonardomathon/interactive-world-happiness-visualization. This will create a directory with the name of this repo and start downloading.

Install dependencies

Once the cloning process has completed, navigate to the cloned repository and open a terminal or command prompt. To install all the required dependencies, use the command npm install. If succesful, this will create a folder called node_modules, containing all of the dependencies

Running the project

Run project (live server)

If everything went right, you are now able to start the project using npm run start in the project root. This initializes webpack and will start a live server at localhost:8080.

Build project

Alternatively, you can use the command npm run build in the project root. This command starts the build process, which bundles all the source files and spits out a static .html file, together with two .js files containing all our written code, as well as all the dependencies used. The static .html file can be found at dist/index.html and can easily be opened using a modern webbrowser.

โžก๏ธ Usage

TODO

Technologies

This project is mainly build with webpack for bundling javascript files and assets, D3 for drawing and displaying graphs, and THREE.js, a lightweigt, 3D librabry with a default WebGL renderer, used to render the main world globe. Other noticable dependencies are Hotkeys.js, a library for capturing keyboard inputs, jsPanel4, a library to create floating panels, hints, modals and other kinds of windows and Tailwind, a utility-first CSS framework.

Acknowledgments

This application was developed by a team of 3 CS master students, namely:

It was developed as part of the course 2IMV20 - Visualization, taught at Eindhoven University of Technology.

interactive-world-happiness-visualization's People

Contributors

jorgbekelaar avatar leonardomathon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.