sudoxreboot/habitica-self-host
1
0
Fork 0
mirror of https://github.com/sudoxnym/habitica-self-host.git synced 2026-07-22 05:44:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(readme): cleanup general installation process

Browse source
This commit is contained in:
Denis 2014-02-22 09:34:56 +02:00
parent 3fe2ea9ea3
commit 59dc47298b
1 changed files with 31 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -16,57 +16,56 @@ Before starting make sure to have [MongoDB](http://www.mongodb.org/), [NodeJS an
`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 -t origin/develop`
1. Install the **npm** packages:
`npm install`
Read below for possible error message.
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