Step 1: Clone this repo
Step 2: Run node install
Step 3: Go make some coffee, this'll run for a while...
After installation completes, the whole suite can be fired up with node run. Note that this will pipe all output from everything into the same console, so this is great for not-looking-at-the-terminal testing, but not a good idea for doing single-component terminal debugging.
NOTE it looks like login.webmaker.org somehow triggers a "too many files open" error when doing an automated npm install. Not sure what causes this (yet) but for the moment you'll have to go into the login.webmaker.org dir and type npm install manually.
node install-webmaker can take four runtime options:
- --username=...
- --password=...
- --s3key=...
- --s3secret=...
These do the obvious thing. If you do not use these, and do not have an .env file (which initially you won't), you will be prompted for them during the bootstrap phase, after npm install for the webmaker-suite package itself finishes.
After the installer finishes everything should be able to run, but you won't be able to publish any makes unless you also make sure that the S3 credentials for all the tools are in the right place. For now, this is a manual job for goggles, thimble, and popcorn. For goggles and thimble, open the .env files and replace the dummy S3 values with the real credentials you want to use. For popcorn, open local.json. This will already have the key and secret that you filled in during installation prefilled, but the buckname will still be just a default name so you'll have to change that to ensure publication will work.
node update-webmaker will update all repositories to their current master branch. It effectively runs the following commands for each repository:
git fetch mozillagit checkout -B master mozilla/masterrm -rf node_modulesnpm installnpm cache clean
node run will run all apps in the webmaker suite. It can take two runtime options:
- --noes
- --nomongo
- --exclude=[comma separated list of names]
The --exclude flag takes a comma separated list of app names that should not be started up. If you wish to test only the MakeAPI, for instance, you could issue node run --exclude=goggles,thimble,popcorn,login,webmaker.org,htmlsanitizer.org. Note that, for convenience, app names that are of the form "xyz.webmaker.org" can be excluded using only the "xyz" part of the name.
These mostly exist to prevent double-starts for elastic search and mongodb, if you already run these on your machine, since node run will try to fire these up for you.
When running the suite, the following locations are available:
- http://localhost:3000 - login.webmaker.org
- http://localhost:3500 - thimble.webmaker.org
- http://localhost:5000 - makeapi
- http://localhost:5050 - htmlsanitizer.org
- http://localhost:7777 - webmaker.org
- http://localhost:8888 - popcorn.webmaker.org
- http://localhost:12416 - goggles.webmaker.org
- node.js - http://nodejs.org/
- npm - comes with node.js
- bower -
npm install -g bower - python - http://python.org/ (pretty sure we depend on 2.7)
- pip -
easy_setup pip(if command unknown, run http://peak.telecommunity.com/dist/ez_setup.py through python, first) - mongodb - http://www.mongodb.org/downloads (or through your favourite package manager)
- elastic search - http://www.elasticsearch.org (or through your favourite package manager)
Windows users need to install these two things first (in order):
- Microsoft Visual Studio C++ 2010 Express, http://go.microsoft.com/?linkid=9709949
- For Windows 7 x64 (which obviously you're on), the Windows 7 64-bit SDK, http://www.microsoft.com/en-us/download/details.aspx?id=8279
(Without this VC++ stack, node-gyp will crash the npm install process when it gets to sqlite3 and tries to build it without having access to the windows C++ compiler and header files. Since several apps rely on sqlite3 for localhost work, you need these).
Also, if you're on windows, MongoDB and Elastic Search require manual installation, which means putting them in their own folders and extending your PATH:
Download mongodb as a zipfile, create a MongoDB folder for it in your program files folder, and copy mongo.exe, mongod.exe etc. into it. Then add the MongoDB folder to your PATH variable (in windows 7, that's control panel -> system -> advanced system settings -> environment variables -> system variables section).
Download elastic search, create a folder C:\elastisearch (I am not kidding, ES has the worst restrictions), and unpack the .zip package into it. Elastic Search requires Java, so if you don't have that install, grab the most recent JDK and install it. Then symlink the jdk dir as c:\java. Again, I am not joking; ES died on spaces anywhere. To do this, open a cmd box with administrative rights, to go C:\ and type:
C:\> mklink /D java "c:\Program Files (x86)\Java\jdk1.6.0_17"
(to remove that at some longer point, simply delete the C:\java dir. It will unlink, rather than delete your jdk files)
Also add C:\elasticsearch\bin to your PATH variable.
You will need the X-Code command line utilities. These are free through Apple's developer appstore. You will also want brew, which is a package manager for OSX.
With these, install mongodb and elasticsearch using brew, and you should be all set. Convenient!
(If you elect to run these on startup, you will want to make sure to use node run --noes --nomongo when you use the suite runner, or run.js will try to double-start ES and MongoDB)
Mongodb may have told itself to log to a file, instead of to the console. If it has, starting mongod will show you a single line of output stating where it's logging to. If this is all you see when you start up Mongo, open its config file by typing the command vi usr/local/etc/mongod.conf, and remove the logging instruction in that file (cursor-navigate to an offending line, then press d twice to delete it. To save and quite, type :, then wq, then hit enter). You should now get normal console output when running mongod, which is essential for the webmaker-suite to run.