Merge pull request #439 from fossasia/development

Getting the master branch even with development.

Author: CloudyPadmal

.github/ISSUE_TEMPLATE

@@ -0,0 +1,36 @@
+---
+name: Report a bug
+about: Report a bug which you have noticed, to help us improve NeuroLab Android app
+title: ''
+labels: Bug
+assignees: jddeep, suresh-gandhi
+
+---
+
+**Describe the bug**
+<!--Please state here what is currently happening.-->
+
+**Expected Behavior**
+<!--A clear and concise description of what you want to happen.-->
+
+**Steps to reproduce it**
+<!--Add steps to reproduce the bug.-->
+
+**LogCat for the issue**
+<!--Provide logs for the crash here.-->
+
+**Screenshots of the issue**
+<!--Where-ever possible add a screenshot of the issue. Use `<img src="paste-link-here" width=200 />` tag-->
+
+**System Information**
+<table>
+<tr>
+  <td>Device</td><td>e.g. Moto G5 Plus</td>
+</tr>
+<tr>
+  <td>Android version/OS</td><td>eg: Oreo 8.1</td>
+</tr>
+</table>
+
+**Would you like to work on the issue?**
+<!--Let us know if this issue should be assigned to you or tell us who you think could help to solve this issue.-->

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for the project Neurolab
+title: ''
+labels: Feature
+assignees: ''
+
+---
+
+**Actual Behaviour.**  
+<!--A clear and concise description of the existing behaviour-->
+
+**Expected Behaviour**  
+<!--A clear and concise description of what you want to happen.-->
+
+**Steps to reproduce it**  
+<!--A clear and concise description of steps you've considered to implement the feature.-->
+
+**Additional context**  
+<!--Add any other context or screenshots about the feature request here.-->
+
+**Would you like to work on the issue?**
+<!--Let us know if this issue should be assigned to you or tell us who you think could help to solve this issue.-->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,16 @@
+---
+name: General issues
+about: Issues related to docs, workflow, dependency and others
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the issue**
+
+<!--Please state here what you want to do.-->
+
+**Would you like to work on the issue?**
+
+<!--Let us know if this issue should be assigned to you or tell us who you think could help to solve this issue.-->

.github/ISSUE_TEMPLATE/general-issues.md

@@ -2,7 +2,7 @@ Fixes #[Add issue number here. Note: This will automatically closes the issue. I
 
 **Changes**: [Add here what changes were made in this issue and if possible provide links.]
 
-**Screenshot/s for the changes**: [Add screenshot/s of the layout where you made changes or a `*.gif` containing a demonstration]
+**Screenshot/s for the changes**: [Add screenshot/s of the layout where you made changes or a `*.gif` containing a demonstration. Use `<img src="paste-url-here" width=200/>` to add images]
 
 **Checklist**: [Please tick following check boxes with `[x]` if the respective task is completed]
 - [ ] I have used resources from `strings.xml`, `dimens.xml` and `colors.xml` without hard-coding them

.github/PULL_REQUEST_TEMPLATE

@@ -4,6 +4,8 @@ sudo: false
 
 jdk: oraclejdk8
 
+dist : trusty
+
 android:
   components:
     - tools

.travis.yml

@@ -0,0 +1,68 @@
+## How to Contribute
+
+### Raising an issue
+ This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests submitting pull requests as well.
+ This project adheres to the Contributor Covenant code of conduct.
+ By participating, you are expected to uphold this code style.
+ Please report issues here [Issues - fossasia/neurolab-android](https://github.com/fossasia/neurolab-android/issues)
+
+### Branch Policy
+
+#### Sending pull requests
+
+Go to the repository on github at <https://github.com/fossasia/neurolab-android>.
+
+Click the “Fork” button at the top right.
+
+You’ll now have your own copy of the original FOSSASIA repository in your github account.
+
+Open a terminal/shell.
+
+Type
+
+`$ git clone https://github.com/fossasia/neurolab-android.git`
+
+where 'username' is your username.
+
+You’ll now have a local copy of your version of the original FOSSASIA repository.
+
+#### Change into that project directory (neurolab-android)
+
+`$ cd neurolab-android`
+
+#### Add a connection to the original owner’s repository
+
+`$ git remote add upstream https://github.com/fossasia/neurolab-android`
+
+#### To check this remote add set up
+
+`$ git remote -v`
+
+#### Make changes to files
+
+`git add` and `git commit` those changes
+
+`git push` them back to github. These will go to your version of the repository.
+
+#### Now Create a PR (Pull Request)
+Go to your version of the repository on github.
+
+Click the “New pull request” button at the top.
+
+Note that FOSSASIA’s repository will be on the left and your repository will be on the right.
+
+Click the green button “Create pull request”. Give a succinct and informative title, in the comment field give a short explanation of the changes and click the green button “Create pull request” again.
+
+#### Pulling others’ changes
+Before you make further changes to the repository, you should check that your version is up to date relative to FOSSASIA’s version.
+
+Go into the directory for the project and type:
+
+`$ git checkout development`
+`$ git pull upstream development --rebase`
+
+This will pull down and merge all of the changes that have been made in the original FOSSASIA repository.
+
+Now push them back to your github repository.
+
+`$ git push origin development`

CONTRIBUTING.md

@@ -2,8 +2,9 @@
 
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/04c9c47bfb934605ab15394dd2f260be)](https://app.codacy.com/app/fossasia/neurolab-android?utm_source=github.com&utm_medium=referral&utm_content=fossasia/neurolab-android&utm_campaign=Badge_Grade_Settings)
 [![Build Status](https://travis-ci.org/fossasia/neurolab-android.svg?branch=master)](https://travis-ci.org/fossasia/neurolab-android)
-[![Gitter](https://badges.gitter.im/fossasia/pslab.svg)](https://gitter.im/fossasia/pslab?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-[![Mailing List](https://img.shields.io/badge/Mailing%20List-FOSSASIA-blue.svg)](mailto:[email protected])
+[![Gitter](https://badges.gitter.im/fossasia/neurolab.svg)](https://gitter.im/fossasia/neurolab?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Mailing List](https://img.shields.io/badge/Mailing%20List-FOSSASIA-blue.svg)](https://groups.google.com/forum/#!forum/pslab-fossasia)
+[![Twitter Follow](https://img.shields.io/twitter/follow/pslabio.svg?style=social&label=Follow&maxAge=2592000?style=flat-square)](https://twitter.com/pslabio)
 
 This repository holds the Android app for the Neurolab Hardware. We are developing a neuro-device as a headband with integrated electronics.
 
@@ -14,3 +15,129 @@ Our brains communicate through neurotransmitters and their activity emits electr
 Current devices in the medical industry are usually not accessible by doctors due to their high pricing. They are also complicated to use. The idea of the device is to integrate it into a headband and focus on signals that can be obtained through the frontal lobe.
 
 A difference to existing projects like OpenBCI is that it will not be necessary to 3D print large headsets. Instead we are focusing on creating a device that collects as much data as possible through the forehead. To achieve this goal we are using high-grade sensors and flexible electronics.
+
+## Screenshots
+<table>
+        
+  <tr>
+  <td><img src="/docs/images/start_screen_1.png" height="500" width="250"></td>
+  <td><img src="/docs/images/home_screen.jpg" height="500" width="250"></td>
+  <td><img src="/docs/images/nav_menu.png" height="500" width="250"></td>
+  </tr>
+  
+  <tr>
+  <td><img src="/docs/images/focus_mode.png" height="500" width="250"></td>
+  <td><img src="/docs/images/memory_graph_sc.jpeg" height="500" width="250"></td>
+  <td><img src="/docs/images/pinlayout.jpeg" height="500" width="250"></td>
+  </tr>
+
+  <tr>
+  <td><img src="/docs/images/meditate.jpg" height="500" width="250"></td>
+  <td><img src="/docs/images/about_screen.png" height="500" width="250"></td>
+  <td><img src="/docs/images/settings_screen.jpeg" height="500" width="250"></td>
+  </tr>
+
+  </table>
+  
+## Features
+
+### Launcher Screen
+
+<td><img src = "/docs/images/home_screen.jpg" height = "500" width="250"></td>
+
+The four major program modes:
+*  [Focus](#focus-program-mode)
+*  [Relax](#relax-program-mode)
+*  [Memory Graph](#memory-graph-program-mode)
+*  [Meditation](#meditation-program-mode)
+
+Every program mode is responsible for specific activities and games with your brain activity.
+
+### Focus program Mode
+
+<td><img src="/docs/images/focus_mode.png" height="500" width="250"></td>
+
+Focus program mode helps users to increase their focus and concentration power by playing games.
+The rocket game comes with features like play, stop, record, program info, datalogger, seek to specific time, etc.
+
+### Relax program mode
+
+<td><img src="/docs/images/relax.jpg" height="500" width="250"></td>
+
+Relax program mode is intended to help users relax his mind and diminish their stress in life.
+
+### Memory Graph program mode
+
+<td><img src="/docs/images/memory_graph_sc.jpeg" height="500" width="250"></td>
+
+Memory Graph is a data visualization mode with the help of graphs, user friendly stats and a density spectrum.
+Users can import a dataset into the datalogger from where they can visualize it in the actual mode.
+This mode is implemented with features like play, stop, record, data logger, etc.
+
+### Meditation program mode
+(Under Development)
+
+<td><img src="/docs/images/meditate.jpg" height="500" width="250"></td>
+
+Meditation program mode helps users with providing different categories of meditations which they can choose depending upon their mood.
+Every category has a list of meditations directed for that particular mood.
+
+Feel free to check out the in-development features of the app like the Meditation mode, bluetooth mode, etc. by enabling the Developer mode from the settings menu. We will be happy to receive your feedback and work on that.
+  
+## Contributions Best Practices
+
+### For first time Contributors
+
+First time contributors can read [CONTRIBUTING.md](/CONTRIBUTING.md) file for help regarding creating issues and sending pull requests.
+
+### Branch Policy
+
+We have the following branches
+**development** All development goes on in this branch. If you're making a contribution, you are supposed to make a pull request to _development_. PRs to development branch must pass a build check and a unit-test check on Circle CI.
+
+**master** This contains shipped code. After significant features/bugfixes are accumulated on development, we make a version update and make a release.
+
+**apk** This branch contains two apk's, that are automatically generated on the merged pull request a) debug apk and b) release apk.
+
+*   Please download and test the app that is using the code from the development and master branches [here](https://github.com/fossasia/neurolab-android/tree/apk).
+ 
+### Code practices
+
+Please help us follow the best practices to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.
+*   Single commit per pull request
+*   For writing commit messages please read the COMMITSTYLE carefully. Kindly adhere to the guidelines.
+*   Follow uniform design practices. The design language must be consistent throughout the app.
+*   The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
+*   If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
+
+### Join the development
+
+*   Before you join development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring :wink: Only thing that will happen is, you'll be more familiar with what is where     and might even get some cool ideas on how to improve various aspects of the app.)
+*   Also please set up the [neurolab-desktop](https://github.com/fossasia/neurolab-desktop) project to your local machine in IntelliJ and explore it, as we are developing this android application based on the desktop-application.
+*   If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.
+
+## For Testers: Testing the App
+If you are a tester and want to test the app, you have two ways to do that:
+1. **Installing APK on your device:** You can get debug APK as well as Release APK in apk branch of the repository. After each PR merge, both the APKs are automatically updated. So, just download the APK you want and install it on your device. The APKs will always be the latest one.
+  
+## External Depenedencies
+*   [Preference Fix Library](https://github.com/Gericop/Android-Support-Preference-V7-Fix)
+*   [JSyn Library](http://www.softsynth.com/jsyn/beta/jsyn_on_android.php)
+*   [Android About Page](https://github.com/medyo/android-about-page)
+*   [Open Sound Control library](https://github.com/medyo/android-about-page)
+*   [Java Simple Serial Connector](https://mvnrepository.com/artifact/org.scream3r/jssc/2.8.0)
+*   [JTransforms](https://mvnrepository.com/artifact/net.sourceforge.jtransforms/jtransforms/2.4.0)
+*   [Java Open GL](https://mvnrepository.com/artifact/org.jogamp.jogl/jogl-all-main/2.3.2)
+*   [Circle ImageView](https://github.com/hdodenhof/CircleImageView)
+*   [MP Android Chart - Chart Library](https://github.com/PhilJay/MPAndroidChart)
+*   [USB Serial Controller](https://github.com/felHR85/UsbSerial)
+*   [App Intro](https://github.com/AppIntro/AppIntro)
+*   [JFreeChart](https://mvnrepository.com/artifact/org.jfree/jfreechart/1.0.14)
+*   [OpenCSV](https://mvnrepository.com/artifact/com.opencsv/opencsv/4.6)
+*   [Gson](https://mvnrepository.com/artifact/com.google.code.gson/gson/2.8.5)
+
+## Maintainers and Developers
+
+*   Jaideep Prasad ([@jddeep](https://github.com/jddeep))
+*   Mario Behling ([@mariobehling](http://github.com/mariobehling))
+*   Padmal ([@CloudyPadmal](https://github.com/CloudyPadmal))

README.md

@@ -12,21 +12,58 @@ android {
         versionCode 1
         versionName "1.0.0"
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+        vectorDrawables.useSupportLibrary = true
+        multiDexEnabled true
     }
     buildTypes {
         release {
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+            resValue "string", "version", "${defaultConfig.versionName}"
         }
+        debug {
+            versionNameSuffix "Version: "
+            resValue "string", "version", "${versionNameSuffix}${defaultConfig.versionName}"
+        }
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+    packagingOptions {
+        exclude 'META-INF/proguard/androidx-annotations.pro'
+    }
+    lintOptions {
+        disable 'InvalidPackage'
+        disable 'RestrictedApi'
     }
 }
 
 dependencies {
-    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation fileTree(include: ['*.jar'], dir: 'libs')
+    implementation "com.google.code.gson:gson:$rootProject.gsonLibraryVersion"
     implementation "com.android.support:support-annotations:$rootProject.supportLibraryVersion"
     implementation "com.android.support:appcompat-v7:$rootProject.supportLibraryVersion"
+    implementation "com.takisoft.fix:preference-v7:$rootProject.prefFixLibraryVersion"
     implementation "com.android.support:design:$rootProject.supportLibraryVersion"
+    implementation "com.android.support:support-v4:$rootProject.supportLibraryVersion"
     implementation "com.android.support.constraint:constraint-layout:$rootProject.constraintLayoutVersion"
+    implementation "com.android.support:cardview-v7:$rootProject.supportLibraryVersion"
+    implementation "com.android.support:recyclerview-v7:$rootProject.supportLibraryVersion"
+    implementation "com.github.medyo:android-about-page:$rootProject.aboutPageLibraryVersion"
+    implementation "com.github.iamareebjamal:jsyn:$rootProject.jsynLibraryVersion"
+    implementation "com.illposed.osc:javaosc-core:$rootProject.javaOscLibraryVersion"
+    implementation "org.scream3r:jssc:$rootProject.jsscLibraryVersion"
+    implementation "net.sourceforge.jtransforms:jtransforms:$rootProject.jtransformsLibraryVersion", { exclude group: 'junit' }
+    implementation "org.jogamp.jogl:jogl-all:$rootProject.joglLibraryVersion"
+    implementation "de.hdodenhof:circleimageview:$rootProject.circleImageViewLibraryVersion"
+    implementation "com.github.PhilJay:MPAndroidChart:v$rootProject.mpandroidchartLibraryVersion"
+    implementation "com.github.felHR85:UsbSerial:$rootProject.usbSerialLibraryVersion"
+    implementation "com.github.AppIntro:AppIntro:$rootProject.appIntroLibraryVersion"
+    implementation "org.jfree:jfreechart:$rootProject.jfreechartLibraryVersion"
+    implementation "com.opencsv:opencsv:$rootProject.opencsvLibraryVersion", {
+        exclude group: "commons-logging", module: "commons-logging"
+    }
     // Test
     testImplementation "junit:junit:$rootProject.junitVersion"
     androidTestImplementation "com.android.support.test:runner:$rootProject.testRunnerRulesVersion"