event-footprint v0.0.1

Event Footprint Template

Used to display a general overview of an event. This makes use of many of the react widgets (metrics, leaderboards, etc).

Preview / Demo

http://s3.amazonaws.com/edh-widgets/event-footprint/index.html

Required information for a new client

https://docs.google.com/document/d/18AA0gF0dfs5Bo7qKT_7pN2RHq2wbhv9LNamcshOmPHY/edit?usp=sharing

Get Started

Install Dependencies

Install gulp globally if you don't have it already:

npm install -g gulp

Still in terminal:

git clone https://github.com/everydayhero/event-footprint.git
cd event-footprint
npm install

Run Dev

• Run npm start in terminal
• Open http://localhost:3000 in your browser

View iframe implementation demo

• Browse to this project's root dir in terminal: cd event-footprint
• Make sure the dist folder is built: gulp build
• Run python -m SimpleHTTPServer in terminal
• Open http://localhost:8000/iframe/index.html in your browser

Deployment

Hosted on S3. Create aws.json file in project root with the following:

{
  "bucket" : "AWS_BUCKET",
  "key" : "AWS_KEY",
  "secret" : "AWS_SECRET"
}

Then run npm run publish to deploy.

Configuration

General / Widgets

src/index.md

Colours

src/scss/_variables.scss

Images

Logo Regular

src/img/logo.png

Logo Small (max height: 40px)

src/img/logo-small.png

Banner Fallback (used when there's not enough supporters)

src/img/bannerFallback.jpg

About Banner

src/img/aboutBanner.jpg

Support A Friend Banner (optional)

src/img/supportAFriendBanner.jpg