sudoxreboot/habitica
1
0
Fork 0
mirror of https://github.com/sudoxnym/habitica.git synced 2026-04-14 19:56:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #2926 from denis-sokolov/readme-improvements

Browse source 
Readme improvements
This commit is contained in:
Tyler Renelle 2014-02-27 09:31:48 -08:00
commit 1fa3d53514
1 changed files with 36 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
README.md
View file

@ -3,7 +3,7 @@ HabitRPG [![Build Status](https://travis-ci.org/HabitRPG/habitrpg.png?branch=dev
[HabitRPG](https://habitrpg.com) is an open source habit building program which treats your life like a Role Playing Game. Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor.
Built using Angular, Express, Mongoose, Jade, Stylus, Grunt and Bower.
Built using [Angular](http://angularjs.org/), [Express](http://expressjs.com/), [Mongoose](http://mongoosejs.com/), [Jade](http://jade-lang.com/), [Stylus](http://learnboost.github.io/stylus/), [Grunt](http://gruntjs.com/) and [Bower](http://bower.io/).
# Set up HabitRPG locally
@ -12,61 +12,60 @@ Built using Angular, Express, Mongoose, Jade, Stylus, Grunt and Bower.
Before starting make sure to have [MongoDB](http://www.mongodb.org/), [NodeJS and npm](http://nodejs.org/) and [Git](https://help.github.com/articles/set-up-git) installed and set up.
1. [Fork the repository](https://help.github.com/articles/fork-a-repo) on your computer.
1. Checkout the **develop** branch where all the development happens:
`git checkout -b develop origin/develop`
1. Checkout the `develop` branch where all the development happens:
`git checkout -t origin/develop`
1. Install **grunt-cli** npm package globally (on some systems you may need to add `sudo` in front of the command below):
`npm install -g grunt-cli bower`
1. Install the **npm** and **bower** packages:
`npm install`
1. Install our dependencies: `npm install`
1. Create a config file from the example one:
`cp config.json.example config.json`
1. Ensure that Mongo is running and seed the database with initial settings by running:
`node ./src/seed.js`.
1. Ensure that Mongo is running and seed the database with initial settings by running:
`node src/seed.js`.
## Windows Environment Install
1. Set up MongoDB. Steps:
1. Download the latest production release of MongoDB from: http://www.mongodb.org/downloads
1. Extract the zip file to the desired application directory. Example: c:\apps\mongodb-win32-x86_64-2.4.6
1. Rename the folder from mongodb-win32-x86_64-2.4.6 to mongodb
1. Create a data\db directory under the application directory. Example: c:\apps\mongodb\data\db
1. Start up MongoDB using the following command:
'c:\apps\mongodb\bin\mongod.exe --dbpath c:\apps\mongodb\data'
1. Download the [latest production release of MongoDB](http://www.mongodb.org/downloads)
1. Extract the zip file to the desired application directory. Example: `c:\apps\mongodb-win32-x86_64-2.4.6`
1. Rename the folder from `mongodb-win32-x86_64-2.4.6` to `mongodb`
1. Create a `data\db` directory under the application directory. Example: `c:\apps\mongodb\data\db`
1. Start up MongoDB using the following command: `c:\apps\mongodb\bin\mongod.exe --dbpath c:\apps\mongodb\data`
If MongoDB starts up successfully, you should see the following at the end of the logs:
```Sun Sep 01 18:10:21.233 [initandlisten] waiting for connections on port 27017
Sun Sep 01 18:10:21.233 [websvr] admin web console waiting for connections on po
rt 28017```
If MongoDB starts up successfully, you should see the following at the end of the logs:
1. Install Node.js (includes npm). Steps:
1. Download and run the latest Node.js msi installation file from http://nodejs.org/download/
1. Install [Git](https://help.github.com/articles/set-up-git).
```
Sun Sep 01 18:10:21.233 [initandlisten] waiting for connections on port 27017
Sun Sep 01 18:10:21.233 [websvr] admin web console waiting for connections on port 28017
```
1. [Install Node.js](http://nodejs.org/download/) (includes npm).
1. [Install Git](https://help.github.com/articles/set-up-git).
1. [Fork the repository](https://help.github.com/articles/fork-a-repo) on your computer.
1. Checkout the **develop** branch where all the development happens:
`git checkout -b develop origin/develop`
1. Install the **npm** packages:
`npm install`
Read below for possible error message.
1. Checkout the `develop` branch where all the development happens:
`git checkout -t origin/develop`
1. Install our dependencies: `npm install`.
You might receive the following error during the 'npm install' command:
> habitrpg@0.0.0-152 postinstall C:\Users\022498\Projects\habitrpg
> ./node_modules/bower/bin/bower install -f
'.' is not recognized as an internal or external command,
operable program or batch file.
npm ERR! weird error 1
npm ERR! not ok code 0
You might receive the following error during the `npm install` command:
Ignore this error and proceed with the following:
```
habitrpg@0.0.0-152 postinstall C:\...\habitrpg
./node_modules/bower/bin/bower install -f
'.' is not recognized as an internal or external command,
operable program or batch file.
npm ERR! weird error 1
npm ERR! not ok code 0
```
Ignore this error and proceed with the following:
1. Install **grunt-cli** and **bower** npm packages globally
'npm install -g grunt-cli bower'
1. Install **grunt-cli** and **bower** npm packages globally:
`npm install -g grunt-cli bower`
1. Install the **bower** packages:
'bower install -f'
`bower install -f`
1. Create a config file from the example one:
`copy config.json.example config.json`
1. Ensure that Mongo is running and seed the database with initial settings by r
unning:
`node .\src\seed.js`.
`node src\seed.js`.
# Run HabitRPG