wdi-sg / project-template

WDI Project Template

Your Project Name

This is the starter code for WDI projects. Please update this README file with information specific to your project. Replace this paragraph for instance, with a short description of your project. Then update the sections below. Refer to your project specificaion for instructions on how to submit your projects.

Getting Started

Provide instructions here about how to get your project running on our local machine. Do we just need to clone and open a certain file or do we need to install anything first.

Prerequisites

What is needed to install and run the project, how do we install them

Code example

How to Use

A step by step guide on how to install and use the project, for example if this is a game, how do we play it.

Code example

More steps...

until finished

Tests

Did you write automated tests? If so, how do we run them.

Code example

Live Version

Where is this deployed online (github pages, heroku etc), give us the link and any access details we need.

Built With

What did you use to build it, list the technologies, plugins, gems, packages etc.

• jQuery - jQuery for example is something you likely used

Workflow

Did you write user stories, draw wireframes, use task tracking, produce ERDs? Did you use source control, with regular commits? Include links to them here.

Authors

Did you collaborate with others on this project, list them here

• John McClain - Responsible for keeping vests white - GithubUserName

Acknowledgments

• Hat tip to anyone who's code was used, for example this was a useful starting point for creating this template.