mirror of
https://github.com/sudoxnym/habitica.git
synced 2026-04-14 19:56:23 +00:00
No description
| archive | ||
| assets | ||
| locales | ||
| migrations | ||
| public | ||
| src | ||
| test | ||
| views | ||
| .bowerrc | ||
| .gitignore | ||
| .gitmodules | ||
| bower.json | ||
| config.json.example | ||
| LICENSE | ||
| Makefile | ||
| package.json | ||
| Procfile | ||
| 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.gitcd habirpg && npm installnpm 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.localsfrom 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.