S-L Project Template

This template will help you get started with your project. Please look through all these materials so you know how to organize your project.

The Associated GitHub Pages Website

This website is served automatically from the default gh-pages branch at https://northeastern-ds-4200-f19.github.io/project-team-11-pedestrians/

Setup

Under no circumstances should you be editing files via the GitHub user interface. Do all your edits locally after cloning.

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. E.g., http://northeastern-ds-4200-f19.github.io/project-team-#-topic where # and topic are customized.

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

4. Start a simple python webserver. E.g., python -m http.server, python3 -m http.server, or py -m http.server. If you are using python 2 you will need to use python -m SimpleHTTPServer instead, but please switch to python 3.

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.

• visualization.js will contain your JavaScript and D3 code.

• 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.

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

Workflow

As you work with your team, you may have issues merging your changes. We recommend you pick one member of the team to be the project manager and deal with merging any pull requests.

Instead of all working directly out of the main gh-pages branch, you can try adopting a Git branching model for development. See, e.g., this article by Vincent Driessen and the included image: