Skip to content

Latest commit

 

History

History
82 lines (57 loc) · 2.41 KB

readme.md

File metadata and controls

82 lines (57 loc) · 2.41 KB

NudgePad

NudgePad let's you build websites in your browser. We are actively developing NudgePad and are breaking things a little too much. For that we apologize, but we want to get it right for version 1.0. A release date for version 1.0 has not yet been finalized, but will be sometime in 2013.

Try it

Try it now at http://nudgepad.com

Requirements

Nudgepad currently works (occasionally) on Mac OS X and Ubuntu.

NudgePad requires node v0.8.23 (does NOT currently work reliably with node v0.10.x due to some proxy/websocket issues).

It also requires mon, which can easily be installed like so:

cd ~
git clone https://github.com/visionmedia/mon.git
cd mon
sudo make install

Occasionally you'll need to update your environment's PATH variable to make sure that the node_modules/.bin folder is included. For example, you may need to add this to your .bash_profile or .bashrc:

PATH=$PATH:~/node_modules/.bin

NudgePad consists of a control panel Express app running on port 3000, user sites which run on ports 3001 - 8000, and an http-proxy app which sits in front of all of those on port 80. You can access the control panel app by going to http://localhost/, or if it's running on a production server by going to http://YOURHOSTNAME/. The panel app let's you instantly create more sites that have a domain name like *.localhost on localhost, or *.YOURHOSTNAME on a production server. If you are not running on localhost, be sure to update the hostname of your machine to match the machine's DNS name, and you'll want to create a CNAME or A Record in your DNS to point *.YOURHOSTNAME to the machine's IP or DNS.

Installing

If you'd like to host Nudgepad on your owner server or development machine, follow the steps below.

npm install nudgepad
np start
# Go to http://YOUR_MACHINE_HOSTNAME

All the code for Nudgepad will be stored in the node_modules/nudgepad folder. All user, temp, and log data will be written to /nudgepad/.

Installing Development Version

If you'd like to contribute to NudgePad development, follow these steps:

cd ~
git clone git@github.com:nudgepad/nudgepad.git
cd nudgepad
make install
npd start
# Go to http://localhost

Uninstalling

The following will remove the npm version:

npm uninstall nudgepad

To remove the development version (and ALL user data) run:

npd uninstall