Skip to content

development.md

Latest commit

 

History

History
110 lines (84 loc) · 3.34 KB

development.md

File metadata and controls

110 lines (84 loc) · 3.34 KB

Developing progrid.io server

development gif

summary

progrid.io server has a pretty slick Vagrant-based development environment packaged and ready to go. Learn more about how Vagrant benefits you.

dependencies

You need these things installed on your machine to get started:

Windows users: we have tried GnuWin32 and it works fine

get started

To spawn a fully-functioning development environment all you have to do is run:

# inside the project directory
vagrant up

This gives you an Ubuntu 14.04 LTS guest machine with

Your entire project directory is rsynced one time to the guest machine. Changes to the following folders are updated live on the guest machine as you work on them:

  • lib/
  • test/
  • site/

Every time you change a file in lib/, the progrid.io server process is automatically restarted

commands

All commands are run inside the project directory. Refer to the Vagrant Command-Line Interface Documentation for a full list of Vagrant commands.

vagrant up

spawns vagrant development environment

vagrant destroy

completely deletes your vagrant development environment and cleans up after itself

vagrant ssh

run commands inside the guest machine

make install

Every time you modify the package.json and change progrid.io server’s dependencies, you must update the guest machine’s slug with make install. This command will:

  1. use rsync to sync the new package.json with the updated list of dependencies to the guest machine.
  2. npm prune to get rid of any unused dependencies.
  3. npm install to install any new dependencies.

make logs

Live tail of the server log files. Useful for debugging purposes. Logs are located at var/log/node.log on the guest machine FYI.

make test

runs progrid.io server’s Mocha test suite.

make jshint

runs JSHint on the .js files inside lib/ and test/.

make sync

Any time you make edits outside of lib/, test/, or site/ you must sync these changes over to the guest machine. You will not have to use this command very often however.

now what?

progrid.io server is only half of progrid.io. You need a progrid.io client to connect to your server.

progrid.io client

need help?

Opening an issue is the fastest way to get help. You can also try pinging Austin Pray (@austinpray) on Twitter.