Skip to content

Commit

Permalink
prettifying README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Xeus committed May 1, 2012
1 parent cb19f42 commit 683d329
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 27 deletions.
66 changes: 41 additions & 25 deletions README.md
Expand Up @@ -2,51 +2,67 @@

by Ben Turner (@Xeus)

http://karaokeflow.herokuapp.com/
https://github.com/Xeus/Karaoke-Flow
Demo: http://karaokeflow.herokuapp.com/
Github: https://github.com/Xeus/Karaoke-Flow

# Description
## Description

Project for John Schimmel's Dynamic Web Development class at NYU-ITP.

http://itpwebclass.herokuapp.com/
DWD Notes: http://itpwebclass.herokuapp.com/

Party game. People get 5 minutes to create rhymes from a prompt of 2 common rap
topics. Then when time's up, someone has to perform the song and should be
judged on his/her flow!
Party game. People get 5 minutes to create rhymes from a prompt of 2 common rap topics. Then when time's up, someone has to perform the song and should be judged on his/her flow!

# Installation
## Installation

Open your terminal/shell/command prompt. Make sure you have Node.js installed.
Open your terminal/shell/command prompt. Make sure you have Node.js installed. http://nodejs.org/

http://nodejs.org/
Clone the repository. Type 'git clone git@github.com:Xeus/Karaoke-Flow.git' in the parent directory you wish to install "./Karaoke-Flow" to.

Clone the repository. Type 'git clone git@github.com:Xeus/Karaoke-Flow.git' in
the parent directory you wish to install "./Karaoke-Flow" to.
See package.json for dependencies. Type 'npm install' to install them. Uses MongoDB and the Heroku toolbelt.

See package.json for dependencies. Type 'npm install' to install them. Uses
MongoDB and the Heroku toolbelt.
MongoDB: http://www.mongodb.org/downloads
Heroku toolbelt: https://toolbelt.heroku.com/

http://www.mongodb.org/downloads
https://toolbelt.heroku.com/

Set up your .env file to include your MONGOLAB_URI variable, which has your
user/pass to connect to MongoDB. Your .env will also hold a variable SECRETSTRING which salts your user db. So the .env file will look like this:
Set up your .env file to include your MONGOLAB_URI variable, which has your user/pass to connect to MongoDB. Your .env will also hold a variable SECRETSTRING which salts your user db. So the .env file will look like this:

MONGOLAB_URI=mongodb://user:pass@host:port/dbname
SECRETSTRING=yourstring

Type 'foreman start' in the "./Karaoke-Flow" directory to start up the
node.js process. This is needed so node.js can access the .env file.
Type

'foreman start'

in the "./Karaoke-Flow" directory to start up the node.js process. This is needed so node.js can access the .env file.

Connect to http://localhost:5000 to get your flow started! Or see an online demo at http://karaokeflow.herokuapp.com/ with a populated db.

## Dependencies

From package.json:

Connect to http://localhost:5000 to get your flow started! Or see an
online demo at http://karaokeflow.herokuapp.com/ with a populated db.
{
"name": "Karaoke-Flow",
"version": "0.8.0",
"dependencies": {
"express": "2.5.6",
"ejs": "latest",
"mongoose" : "2.5.6",
"request" : "latest",
"express": "2.5.8",
"mongodb" : "0.9.6-7",
"connect-mongodb": ">= 1.1.3",
"bcrypt" : "0.4.1",
"passport": "0.1.7",
"passport-local": "0.1.2",
"underscore": ""
}

# Changes
## Changes

Last update 01 May 12: Added more helpful comments/docs, updated README.md.

# TODO:
## TODO:
- fix gap in looped beat tracks (HTML5 bug?)
- duplicate topics in flow metadata need to be fixed
- user account page needs to be indented
Expand Down
4 changes: 2 additions & 2 deletions package.json
@@ -1,6 +1,6 @@
{
"name": "Karaoke-Flow",
"version": "0.0.9",
"version": "0.8.0",
"dependencies": {
"express": "2.5.6",
"ejs": "latest",
Expand All @@ -14,4 +14,4 @@
"passport-local": "0.1.2",
"underscore": ""
}
}
}

0 comments on commit 683d329

Please sign in to comment.