Skip to content

Latest commit

 

History

History
56 lines (31 loc) · 2.41 KB

README.md

File metadata and controls

56 lines (31 loc) · 2.41 KB
Raw

Project Team SBN1: Sustainable Business Network, DS 4200 S20

This project was made by Anika Rabenhorst, Samantha Roman, Gisselle Rodriguez Benitez, and Suraj Korumilli as a Service-Learning project for Sustainable Business Network of Massachusetts. Knowledge of d3 and data visualization comes from Northeastern University's DS4200: Information Presentation and Visualization class (https://canvas.instructure.com/courses/1781714).

The GitHub Pages Website

https://neu-ds-4200-s20.github.io/s-l-project-sbn1/

Link to demo video

https://drive.google.com/open?id=1NW5MTK24EelX3ZgIW7JO1y7sj3T5EsJX

Setup

  1. Clone this repository to your local machine. E.g., in your terminal / command prompt CD to where you want this the folder for this activity to be. Then run git clone <YOUR_REPO_URL>

  2. In README.md update the URL above to point to your GitHub pages website.

  3. CD or open a terminal / command prompt window into the cloned folder.

  4. Start a simple python webserver. E.g., one of these commands:

    • python -m http.server 8000
    • python3 -m http.server 8000
    • py -m http.server 8000 If you are using Python 2 you will need to use python -m SimpleHTTPServer 8000 instead, but please switch to Python 3 as Python 2 will be sunset on 2020.01.01.

  5. Wait for the output: Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/)

  6. Now open your web browser (Firefox or Chrome) and navigate to the URL: http://localhost:8000

Root Files

  • README.md is this explanatory file for the repo.

  • index.html contains the main website content. It includes comments surrounded by <!-- and --> to help guide you through making your edits.

  • style.css contains the CSS.

  • LICENCE is your source code license.

Folders

Each folder has an explanatory README.md file

  • data is where you will put your data files.

  • favicons contains the favicons for the course projects. You shouldn't change anything here.

  • files will contain your slides (PDF) and video (MP4).

  • images will contain your screenshots, diagrams, and photos.

  • js will contain all JavaScript files you write.

    • visualization.js is the main code that builds all your visualizations. Each visualization should be built following the Reusable Chart model

  • lib will contain any JavaScript library you use. It currently includes D3.