T

Tyler Renelle bc4798b354 groups: big changes here i may decide to revert. GET /api/v1/groups

optionally takes ?type=guilds (guilds, party, tavern, public). this
allows us to incrementally load the app as they click through the tabs,
because guilds is really large (1.5mb!) - gotta cut this down
somehow. The big issue is requireing return values as an array, so
ngResource can work with the response (subsequent group.$postChat(),
group.$join(), etc.). The array format doesn't really work out that
well, so I may scrap

2013-08-31 22:59:35 -04:00

README.md

HabitRPG Rewrite

HabitRPG Rewrite under development. Built using Angular, Express, Mongoose, Jade, Stylus, Coffeescript.

Note: This branch is under development, and these instructions may fall out of date. They were accurate as of August 5, 2013. Should you encounter this, join #habitrpg on IRC (Freenode) and talk to litenull.

The general steps are:

Clone the repo
Install all dependencies
Run the client

Or, expressed in commands on the command line:

git clone --recursive -b angular_rewrite https://github.com/lefnire/habitrpg.git
cd habirpg && npm install
npm start

To access the site, open http://localhost:3000 in your browser.

Technologies

Angular, Express, Mongoose. Awesome, tried technologies. Read up on them.
CoffeeScript, Stylus, Jade - big debate.
Jade. We need a server-side templating language so we can inject variables (res.locals from Express). Jade is great because the "significant whitespace" paradigm protects you from HTML errors such as missing or mal-matched close tags, which has been a pretty common error from multiple contribs on Habit. However, it's not very HTML-y, and makes people mad. We'll re-visit this conversation after the rewrite is done.
Stylus. We're either staying here or moving to LESS, but vanilla CSS isn't cutting it for our app.
CoffeeScript. This is the hottest debate. I'm using it to rewrite, and Habit was written originally on CS. It's a fantastic language, but it's a barrier-to-entry for potential contribs who don't know it. Will also revisit right after the rewrite.