artin/community-app
1
0
Fork 0
mirror of https://github.com/openMF/community-app.git synced 2026-02-06 11:46:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

improveme build steps in README

Browse Source
This commit is contained in:
Michael Vorburger ⛑️ 2020-04-26 18:23:05 +02:00 committed by GitHub
parent 546e015b74
commit 2241f3a200
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -14,23 +14,27 @@ This is the default web application built on top of the MifosX platform for the
* ```npm``` installed - goto http://nodejs.org/download/ to download the installer for your OS.
* ```ruby``` installed - goto https://www.ruby-lang.org/en/documentation/installation/ to download the latest version of ruby.
<br/> Note: On Ubuntu Linux you can use 'sudo apt-get install npm nodejs-legacy' (nodejs-legacy is required to avoid the ""/usr/bin/env: node: No such file or directory" problem).
<br/> Tip: If you are using Ubuntu/Linux, then doing ```npm config set prefix ~``` prevents you from having to run npm as root.
Note: On Ubuntu Linux you can use `sudo apt-get install npm nodejs-legacy`, which avoids the `/usr/bin/env: node: No such file or directory` problem.
1. Clone this repository to your local filesystem (default branch is 'develop')
Note that on Linux distributions you'll need to install the Ruby Development package (e.g. `sudo dnf install ruby-devel` on Fedora), and not just `ruby`, otherwise `bundle install` below will fail when it gets to installing `ffi` which uses native extensions.
1. Clone this repository to your local filesystem (default branch is 'develop'):
```
git clone https://github.com/openMF/community-app.git
```
1. To download the dependencies, and be able to build, first install bower & grunt
1. To download the dependencies, and be able to build, first install bower & grunt:
```
npm install -g bower
npm install -g grunt-cli
```
1. Next pull the runtime and build time dependencies by running bower, npm, and gem bundler install commands on the project root folder
If this fails with `npm WARN checkPermissions Missing write access to /usr/local/lib` and `npm ERR! code EACCES` because you are not running `npm` with `sudo` as `root` (which you rightfully really shouldn't!) then use `npm config set prefix ~` once before doing `npm install`. Note that in that case `bower` and `grunt` will be installed into `./bin/bower` instead of `/usr/local/bin`, and so you need to prefix it in the usages below.
1. Next pull the runtime and build time dependencies by running `bower`, `npm`, and `gem` commands on the project root folder:
```
bower install
@ -44,12 +48,18 @@ This is the default web application built on top of the MifosX platform for the
```
bundle install
```
If you used `npm config set prefix ~`, then you have to use `./bin/bower install` instead of `bower install`.
1. To preview the app, run the following command on the project root folder
1. To preview the app, run the following command on the project root folder:
```
grunt serve
```
If you used `npm config set prefix ~`, then you have to use `./bin/grunt serve` instead of `grunt serve`.
or open the 'index.html' file in FIREFOX browser
Note: If you see a warning similar to the one shown below on running `grunt serve` , try increasing the number of open files limit as per the suggestions at http://stackoverflow.com/questions/34588/how-do-i-change-the-number-of-open-files-limit-in-linux/
@ -59,7 +69,7 @@ This is the default web application built on top of the MifosX platform for the
```
1. You can use these credentials to log in
1. You can use these credentials to log in:
```
Username: mifos