Juke

A flossy way to build a user registration app/component with Express, Redis and Stylus.

Juke is also a great boilerplate for building an Express app.

Requirements

Redis
Node.js 0.4.11
Google Apps Account/SMTP Access (or your own SMTP server)

How-To

Make sure Redis is installed and running on the server.

wget http://redis.googlecode.com/files/redis-2.2.12.tar.gz
tar xzf redis-2.2.12.tar.gz
cd redis-2.2.12
make
sudo make install

To start the redis-server type:

redis-server

This will use the default config.

In order to specify a custom config file use redis-server /path/to/redis.conf'

To enter the redis CLI type:

redis-cli

Now you can GET and SET keys and values. To remove all keys type FLUSHALL.

Grab the necessary modules from the `package.json` file:

npm install -d

To fire up your Juke joint, type:

node app.js

Development Environments

By default, the app.json file has configuration options set for debugging, on localhost at port 5050. This can all be configured by simply changing the values.

If you want to change to localhost but on a production port like 80, change

"DEBUG"

false

Before you restart the app, you'll need to compress/concat the files with smoosh:

smoosh -c app.json

or simply restart the app and if you're debugging, smoosh will be called programmatically and build with the compression flag set.

This will create minified and concatenated CSS and JS files.

Now, restart the app, node app.js, and navigate to http://localhost/.

If you want to actually run this on a production server there are a few things you should do.

First, change the "LOCALHOST" and "DEBUG" values to false and update your CDN values and the verification link to your live site URLs.

Next, start and stop the node app. This will update the stylus file and image prefix for production (we should change this so you can just call the method inside the app.js file, but lazy for now):

Start (and capture process id):

sudo node app.js &; echo $! > node.pid

Stop:

cat node.pid | sudo xargs kill && rm -f node.pid

Now that the proper asset/image prefix is set, let's smoosh it.

smoosh -c app.json

Now, your app is primed and ready for production.

Email Setup

For email configuration, open the email.js file in the utils directory.

There is a configuration hash there. Update it with your credentials.

Redis Keys

Key | Value | Comment

joe | hashedPassw0rdHere!11 | username and hashed password

joe@RAD.com | joe | email address and associated username

joe:isVerified | (un)verified | account verification check

adfs8922dfsa2300 | joe | random, one-time key for account verification

LICENSE

MIT

TODO

Validate incoming inputs.
Lots moar (see the inline code comments)

Credits

Background pattern for the <body> tag: dinpattern.com

joemccann/juke