|
| 1 | +[](https://travis-ci.org/BuildmLearn/BuildmLearn-Toolkit-Android) [](https://www.codacy.com/app/anupam/BuildmLearn-Toolkit-Android?utm_source=github.com&utm_medium=referral&utm_content=BuildmLearn/BuildmLearn-Toolkit-Android&utm_campaign=Badge_Grade) |
| 2 | + |
1 | 3 | # BuildmLearn-Toolkit-Android |
2 | 4 |
|
3 | | -This repository contains the Android version of the BuildmLearn Toolkit. BuildmLearn Toolkit is an easy-to-use program that helps the users make mobile apps without any knowledge of application development. |
| 5 | +This repository contains the Android version of the BuildmLearn Toolkit. BuildmLearn Toolkit app is an easy-to-use android app that helps the users make another mobile apps without any knowledge of android application development. The toolkit helps creating mobile application with various functionality and allows teachers to input their custom content. Targeted at teachers, this toolkit helps them make learning fun and engaging through mobile apps. |
| 6 | + |
| 7 | +# Development Setup |
| 8 | +1. Go to the project repo and click the `Fork` button |
| 9 | +2. Clone your forked repository : `git clone git@github.com:your_name/BuildmLearn-Toolkit-Android.git` |
| 10 | +3. Move to android project folder `cd source-code` |
| 11 | +4. Open the project with Android Studio |
| 12 | + |
| 13 | +Glosarry |
| 14 | +====== |
| 15 | +| Folders | Description | |
| 16 | +| ------------- |:-------------| |
| 17 | +| **source-code** | **Android Project Files** | |
| 18 | +| **ui-design** | **Contains UI mockups and wireframes** | |
| 19 | +| **[X]** | **source-code/app/src/main/java/org/buildmlearn/toolkit** | |
| 20 | +| [X]/activity | Contains various activities | |
| 21 | +| [X]/adapters | Contains various adapters | |
| 22 | +| [X]/fragment | Contains various fragment | |
| 23 | +| [X]/simulator | Contains simulator activity | |
| 24 | +| [X]/templates | Contains various template activities | |
| 25 | +| [X]/model | Contains KeyStoreDetails, SavedProject, TemplateInfos, Tutorial, etc | |
| 26 | +| [X]/utilities | Contains various utilities including SignerThread | |
| 27 | +| [X]/views | Contains text-view font support for old-backed SDKs | |
| 28 | +| [X]/infotemplate | Contains simulator's code for Info Template | |
| 29 | +| [X]/learnspelling | Contains simulator's code for learnspelling Template | |
| 30 | +| [X]/flashcardtemplate | Contains simulator's code for FlashCard Template | |
| 31 | +| [X]/quiztemplate | Contains simulator's code for Quiz Template | |
| 32 | +| [X]/videocollectiontemplate | Contains simulator's code for FlashCard Template | |
| 33 | +| [X]/comprehensiontemplate | Contains simulator's code for Comprehension Template | |
| 34 | +| [X]/[?]/adapter | Contains simulator's adapter for [?] Template | |
| 35 | +| [X]/[?]/data | Contains simulator's SQLiteDatabase code for [?] Template | |
| 36 | +| [X]/[?]/fragment | Contains simulator's fragment for [?] Template | |
| 37 | + |
| 38 | +# How to build |
| 39 | + |
| 40 | +All dependencies are defined in ```source-code/app/build.gradle```. Import the project in Android Studio or use Gradle in command line: |
| 41 | + |
| 42 | +``` |
| 43 | +./gradlew assembleRelease |
| 44 | +``` |
| 45 | + |
| 46 | +The result apk file will be placed in ```source-code/app/build/outputs/apk/```. |
| 47 | + |
| 48 | +#Contribution policy |
| 49 | + |
| 50 | +All contributions should be done in **bug-fixes** branch. PRs must pass build check on Travis-CI. |
4 | 51 |
|
5 | 52 | # License for use and distribution |
6 | 53 |
|
|
0 commit comments