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

Updated documentation Contributing.md (#3207)

Browse Source 
* Updated documentation Contributing.md

* Updated documentation Getting-Started.md
This commit is contained in:
Shivam7-1 2020-06-14 06:35:09 +05:30 committed by GitHub
parent 301daf7a67
commit cb2f163226
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Contributing.md
View File

@ -14,7 +14,7 @@ We would love you to contribute to Community and help make it better than it is
## Building from source ## Building from source
1. Ensure you have 1. Ensure you have:
`npm` installed - goto http://nodejs.org/download/ to download installer for your OS. `npm` installed - goto http://nodejs.org/download/ to download installer for your OS.
`ruby` installed - goto https://www.ruby-lang.org/en/documentation/installation/ to download latest version of ruby. `ruby` installed - goto https://www.ruby-lang.org/en/documentation/installation/ to download latest version of ruby.
@ -24,14 +24,14 @@ We would love you to contribute to Community and help make it better than it is
1. Clone this repository to your local filesystem (default branch is 'develop') 1. Clone this repository to your local filesystem (default branch is 'develop')
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 bower
npm install -g grunt-cli 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 1. Next pull the runtime and build time dependencies by running bower, npm and gem bundler install commands on the project root folder:
``` ```
bower install bower install
@ -45,7 +45,7 @@ We would love you to contribute to Community and help make it better than it is
bundler install bundler 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 grunt serve
@ -61,11 +61,11 @@ We would love you to contribute to Community and help make it better than it is
1. Default username/password: mifos/password. This application will hit the demo server by default. 1. Default username/password: mifos/password. This application will hit the demo server by default.
You are done. 1. You are done.
## <a name="question"></a> Got a Question or Problem? ## <a name="question"></a> Got a Question or Problem?
If you have got any questions or problem, please email to our [mailing list](https://lists.sourceforge.net/lists/listinfo/mifos-developer) If you have got any questions or problem, please email to our [mailing list](https://lists.sourceforge.net/lists/listinfo/mifos-developer).
If you would like to chat about the question in real-time, you can reach out via our [Gitter](https://gitter.im/openMF/community-app) channel. If you would like to chat about the question in real-time, you can reach out via our [Gitter](https://gitter.im/openMF/community-app) channel.
@ -104,9 +104,9 @@ Please consider what kind of change it is:
**Working on your first pull requests ?** You can learn how from this free series [How to Contribute to an Open Source Project on GitHub.](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) **Working on your first pull requests ?** You can learn how from this free series [How to Contribute to an Open Source Project on GitHub.](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
Our central development branch is `develop` , which should be clean and ready for release at any time. Feel free to discuss about any issue in gitter channel Our central development branch is `develop` , which should be clean and ready for release at any time. Feel free to discuss about any issue in gitter channel:
1. **Choose a descriptive branch name** - It should be like `issue-1888` if your are working on issue number 1888 1. **Choose a descriptive branch name** - It should be like `issue-1888` if your are working on issue number 1888.
2. **Create a branch name with this name, starting from develop** - 2. **Create a branch name with this name, starting from develop** -

6
Getting-Started.md
View File

@ -7,7 +7,7 @@ I will be here going through the community-app code mainly as many developers an
Codebaseco Codebaseco
We are using AngularJS and requirejs in our application so that we have proper code organization. Some of the advantages of going this direction include;way are we don’t have to worry about including script tags in the right order when building Angular app and. Also, here we can manually bootstrap our AangularJS application. Some Important Files We are using AngularJS and requirejs in our application so that we have proper code organization. Some of the advantages of going this direction include;way are we don’t have to worry about including script tags in the right order when building Angular app and. Also, here we can manually bootstrap our AangularJS application. Some Important Files
app/index.html app/index.html
This is the first file you will start with usually. Here we have the code for the login page and sidenav. So, any changes you want to do in these components it can be directly done here. Also, you will see a script tag below in body of requirejs This is the first file you will start with usually. Here we have the code for the login page and sidenav. So, any changes you want to do in these components it can be directly done here. Also, you will see a script tag below in body of require js.
<script type='text/javascript' data-main="scripts/loader.js" src='bower_components/requirejs/require.js'></script> <script type='text/javascript' data-main="scripts/loader.js" src='bower_components/requirejs/require.js'></script>
@ -88,10 +88,10 @@ Here all the styles files are defined.
## Localisation ## Localisation
The Community app has support for multiple languages and accordingly, we are using labels inside our application. For example: The Community app has support for multiple languages and accordingly, we are using labels inside our application. For example:
{{‘'label.heading.frequentpostings' | translate}} {{"label.heading.frequentpostings"| translate}}
In locale-en.json file, you will find similar entry and its value in English. We ensure that Make sure when we are adding any new label, we just create an entry in the locale-en file and don’t touch other files. In locale-en.json file, you will find similar entry and its value in English. We ensure that Make sure when we are adding any new label, we just create an entry in the locale-en file and don’t touch other files.
"label.heading.frequentpostings": "Frequent Postings", "label.heading.frequentpostings": "Frequent Postings".