Skip to content

EMC-UI/emc-hackathon-tweets

Repository files navigation

EMC Hackathon Tweets

foo.png

This hackathon example app involves using the twitter search API to retrieve content (tweets) from Twitter. The example uses search strings of from:guychurchward , #emc, and @emc

Getting Started

1. Clone the repo onto your machine. This 'checks out' the code into your local environment.

git clone https://github.com/EMC-UI/emc-hackathon-tweets.git

2. Choose a starting point and checkout one of the read-only step branches

The project is broken into branches from 1 to 9. Branch 1 starts with a minimal skeleton project, branch 9 is the full working example.

full stackers Be brave and start with step-1. You can always look at further steps for hints.

front-endians To start with complete plumbing, and only build the UI, start with step 5

back-endians To start with a complete UI, and build only the plumbing, start with complete-ui

  1. step-1 - Almost nothing. Just a few placeholder files for client and server code
  2. step-2 - Minimal express server with /get and /put endpoints
  3. step-3 - Adds server code to deal with twitter authentication
  4. step-4 - Adds server code to deal with getting tweets
  5. step-5 - Adds raw tweet data delivered to the UI
  6. step-6 - Adds the simplest UI to display tweets
  7. step-7 - Adds a stylesheet to the UI
  8. step-8 - Display tweets in horizontal boxes, but no movement
  9. step-9 - Final working example with css3 animation, sass, and grunt
  10. complete-ui - In this step, the UI is complete, and you provide the backend plumbing

Once you've picked a starting point, checkout one of the named branches. For example, to checkout the step-1 branch:

git checkout step-1

3. Create a branch for your work

The example branches are shared by everyone, so they are read only. Create a branch to contain your work. Maybe name it after your team. For example:

git checkout -b fantastic-five-master

4. Hack away!

The basic workflow you should follow goes like this:

  1. Write code, run code, have fun
  2. git add {filename} to add new files
  3. git commit -a to commit changes to your local repo
  4. git push origin {branch name} to push changes up to github

Here is a git cheatsheet and a good guide for getting started with git.