anitab-org · htinz · Jul 8, 2022
@@ -1,4 +1,3 @@
-
 [![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg?logo=zulip)](https://anitab-org.zulipchat.com/#narrow/stream/222534-mentorship-system)
 [![Documentation](https://img.shields.io/badge/documentation-mentorship--android-green.svg)](https://anitab-org.github.io/mentorship-android/)
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg?logo=GNU)](http://www.gnu.org/licenses/gpl-3.0)
@@ -12,30 +11,31 @@
 This is the Android client for the Mentorship System.
 
 ## Features
-* Once the App is installed, the user can view an onboarding screen that introduces the app and gives the user an idea of how it works.
-* A member gets an option to be a Mentor, a Mentee, or Both.
-* A member can build/customize the app profile with their username, bio, skills, interests, location, occupation, etc. anytime.
-* A member can read and know more about the Mentorship System including the terms and conditions, privacy and policy, and code of conduct.
-* A member can directly access the AnitaB-org Github repo, Zulip chat, and website from this App.
-* A member can refresh every page.
-* A member can view a list of other members and search for a member on the Members Page.
-* A member can search for particular members there in the Mentorship System.
-* A member can sort other members based on their name either (A-Z) OR (Z-A), registration date, and age.
-* A member can filter other members by the label **need mentoring** or **available to mentor**, interest, location, and skills that are given while creating a profile.
-* A member can either send mentorship requests to other members as a Mentor or Mentee according to their interests or reject mentorship requests from other members.
-* A member can track the number of **Pending Requests**, **Accepted Requests**, **Rejected Requests**, and **Completed Requests** and view **Recent Achievements** on the Home Page.
-* A member can view the details of pending, past, and all mentorship requests on the Requests Page.
-* A member can create, update, or delete tasks in their current mentorship relationship.
-* A member can send feedback about the Mentorship System such as reporting a bug, giving suggestions, or other comments.
-* A member can delete their account.
-* A member can change their account password anytime.
+
+- Once the App is installed the user can view an onboarding screen which introduces the app and gives the user an idea of how it works.
+- A member gets an option to be a Mentor, a Mentee, or Both.
+- A member can build/customise the app profile with a username, bio, skills, interests, location, occupation, etc. anytime.
+- A member can read and know more about the Mentorship System including the terms and conditions, privacy and policy, and code of conduct.
+- A member can directly access the AnitaB-org Github repo, Zulip chat and website from this App.
+- A member can refresh every page.
+- A member can view a list of other members and search for a member on the Members Page.
+- A member can search for particular members there in the Mentorship System.
+- A member can sort other members on the basis of their name either (A-Z) OR (Z-A), registration date, and age.
+- A member can filter other members by the label need mentoring or available to mentor, interest, location and skills that are given while creating a profile.
+- A member can either send mentorship requests to other members as a Mentor or Mentee according to their interests or reject mentorship requests from other members.
+- A member can track the number of Pending Requests, Accepted Requests, Rejected Requests, and Completed Requests and view Recent Achievements on the Home Page.
+- A member can view the details of pending, past, and all mentorship requests on the Requests Page.
+- A member can create, update, or delete tasks in their current mentorship relation.
+- A member can send feedback about the Mentorship System such as reporting a bug, giving suggestions, or other comments.
+- A member can delete their account.
+- A member can change their account password anytime.
 
 ## Setting up the project
 
 To setup the project locally read these wiki pages and follow the instructions:
 
- - [Fork, Clone and Remote](https://github.com/anitab-org/mentorship-android/wiki/Fork%2C-Clone-%26-Remote)
- - [Open project in Android Studio](https://github.com/anitab-org/mentorship-android/wiki/Open-the-project-in-Android-Studio)
+- [Fork, Clone and Remote](https://github.com/anitab-org/mentorship-android/wiki/Fork%2C-Clone-%26-Remote)
+- [Open project in Android Studio](https://github.com/anitab-org/mentorship-android/wiki/Open-the-project-in-Android-Studio)
 
 ## Contributing
 
@@ -73,16 +73,17 @@ Contributions of any kind welcome!
 ## Running the UI tests
 
 To run the existing UI tests follow the steps given below:
-* Connect your Android device or open the emulator.
-* On the terminal type: `./gradlew clean build connectedAndroidTest --stacktrace`
-* If the above command is not working try using the command: `gradlew clean build connectedAndroidTest --stacktrace`
-* Wait until all the tests are completed.
-* You will get a report generated with a test summary.
-* See the complete report `./mentorship-android/app/build/reports/androidTests/connected/index.html`
-* The report `./mentorship-android/app/build/reports/androidTests/connected/index.html` will show all the testsuites that have passed as well as failed.
-* To get a more detailed explanation about the tests of a particular testsuite visit respective html file of the testsuite.
+
+- Connect your Android device or open the emulator.
+- On the terminal type: `./gradlew clean build connectedAndroidTest --stacktrace`
+- If the above command is not working try using the command: `gradlew clean build connectedAndroidTest --stacktrace`
+- Wait until all the tests are completed.
+- You will get a report generated with a test summary.
+- See the complete report `./mentorship-android/app/build/reports/androidTests/connected/index.html`
+- The report `./mentorship-android/app/build/reports/androidTests/connected/index.html` will show all the testsuites that have passed as well as failed.
+- To get a more detailed explanation about the tests of a particular testsuite visit respective html file of the testsuite.
   For e.g.: `org.anitab.mentorship.LoginActivityTest.html` will contain the results of all the tests run under that particular testsuite.
-* You can find the respective html files of the different testsuites under the heading classes in `index.html` report.
+- You can find the respective html files of the different testsuites under the heading classes in `index.html` report.
 
 ## Documentation
 
@@ -93,6 +94,7 @@ To learn more about this app you can look at [this project's wiki](https://githu
 Check out the design history at [User Interface Design](https://github.com/anitab-org/mentorship-android/wiki/User-Interface-Design).
 
 Our tech stack includes:
+
 - **Language:** [Kotlin](https://kotlinlang.org/)
 - **Architecture:** Model View ViewModel (MVVM)
 - **Libraries:** [Retrofit](http://square.github.io/retrofit/), [RxJava](https://github.com/ReactiveX/RxJava), ViewModel, LiveData, DataBinding
@@ -101,20 +103,22 @@ Our tech stack includes:
 
 The repository has the following permanent branches:
 
- * **master** This contains the code which has been released.
+- **master** This contains the code which has been released.
 
- * **develop** This contains the latest code. All the contributing PRs must be sent to this branch. When we want to release the next version of the app, this branch is merged into the `master` branch.
+- **develop** This contains the latest code. All the contributing PRs must be sent to this branch. When we want to release the next version of the app, this branch is merged into the `master` branch.
 
- * **apk** This branch contains the apks for the code in the develop branch. The apks are automatically updated when a commit is pushed to `develop` branch.
+- **apk** This branch contains the apks for the code in the develop branch. The apks are automatically updated when a commit is pushed to `develop` branch.
 
 ## Screenshots
-|![Introduction Slider](https://user-images.githubusercontent.com/63957920/107955208-86743280-6fc3-11eb-9d5f-0e1031beb992.jpeg)|![SignUp Screen](https://user-images.githubusercontent.com/63957920/107955263-968c1200-6fc3-11eb-952d-def226ef1174.jpeg)|![Login Page](https://user-images.githubusercontent.com/63957920/107955213-883df600-6fc3-11eb-9d43-768a25f11aff.jpeg)|
-|:---:|:---:|:---:|
-|![Home Page](https://user-images.githubusercontent.com/63957920/107955205-84aa6f00-6fc3-11eb-95c7-4db92f18f6df.jpeg)|![Profile Page](https://user-images.githubusercontent.com/63957920/107955253-94c24e80-6fc3-11eb-9463-39aa50cb382c.jpeg)|![Edit Profile Page](https://user-images.githubusercontent.com/63957920/107955188-7f4d2480-6fc3-11eb-8698-66f41d6ae835.jpeg)|
-|![Relations Page](https://user-images.githubusercontent.com/63957920/107955255-955ae500-6fc3-11eb-8d00-2664a2dce0cc.jpeg)|![Tasks Page](https://user-images.githubusercontent.com/63957920/107955267-9724a880-6fc3-11eb-9b20-c11ee5013014.jpeg)|![Members Page](https://user-images.githubusercontent.com/63957920/107955249-9429b800-6fc3-11eb-9a67-9a9cdafcb8ba.jpeg)|
-|![Filter Members Screen](https://user-images.githubusercontent.com/63957920/107955194-81af7e80-6fc3-11eb-8ce7-c08d7e39b22a.jpeg)|![Member Profile](https://user-images.githubusercontent.com/63957920/107955215-8a07b980-6fc3-11eb-90b8-cde542c517bd.jpeg)|![Send Request Page](https://user-images.githubusercontent.com/63957920/107955259-95f37b80-6fc3-11eb-9e4f-5a284d82195a.jpeg)|
-|![Requests Page](https://user-images.githubusercontent.com/63957920/107955257-955ae500-6fc3-11eb-8aec-488ed1cd8e0a.jpeg)|![Settings Screen](https://user-images.githubusercontent.com/63957920/107955260-95f37b80-6fc3-11eb-8862-4e0668c6d6e1.jpeg)|![About Page](https://user-images.githubusercontent.com/63957920/107955159-76f4e980-6fc3-11eb-87f8-464d6e9b9db4.jpeg)|
-|![Change Password Page](https://user-images.githubusercontent.com/63957920/107955177-7bb99d80-6fc3-11eb-8a61-729001a3c330.jpeg)|![Logout Screen Page](https://user-images.githubusercontent.com/57872757/126679249-89fb62d3-8dd0-4ec8-a8f5-865d92df57bb.jpg)|
+
+|  ![Introduction Slider](https://user-images.githubusercontent.com/63957920/107955208-86743280-6fc3-11eb-9d5f-0e1031beb992.jpeg)  |   ![SignUp Screen](https://user-images.githubusercontent.com/63957920/107955263-968c1200-6fc3-11eb-952d-def226ef1174.jpeg)   |    ![Login Page](https://user-images.githubusercontent.com/63957920/107955213-883df600-6fc3-11eb-9d43-768a25f11aff.jpeg)     |
+| :------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------: |
+|       ![Home Page](https://user-images.githubusercontent.com/63957920/107955205-84aa6f00-6fc3-11eb-95c7-4db92f18f6df.jpeg)       |   ![Profile Page](https://user-images.githubusercontent.com/63957920/107955253-94c24e80-6fc3-11eb-9463-39aa50cb382c.jpeg)    | ![Edit Profile Page](https://user-images.githubusercontent.com/63957920/107955188-7f4d2480-6fc3-11eb-8698-66f41d6ae835.jpeg) |
+|    ![Relations Page](https://user-images.githubusercontent.com/63957920/107955255-955ae500-6fc3-11eb-8d00-2664a2dce0cc.jpeg)     |    ![Tasks Page](https://user-images.githubusercontent.com/63957920/107955267-9724a880-6fc3-11eb-9b20-c11ee5013014.jpeg)     |   ![Members Page](https://user-images.githubusercontent.com/63957920/107955249-9429b800-6fc3-11eb-9a67-9a9cdafcb8ba.jpeg)    |
+| ![Filter Members Screen](https://user-images.githubusercontent.com/63957920/107955194-81af7e80-6fc3-11eb-8ce7-c08d7e39b22a.jpeg) |  ![Member Profile](https://user-images.githubusercontent.com/63957920/107955215-8a07b980-6fc3-11eb-90b8-cde542c517bd.jpeg)   | ![Send Request Page](https://user-images.githubusercontent.com/63957920/107955259-95f37b80-6fc3-11eb-9e4f-5a284d82195a.jpeg) |
+|     ![Requests Page](https://user-images.githubusercontent.com/63957920/107955257-955ae500-6fc3-11eb-8aec-488ed1cd8e0a.jpeg)     |  ![Settings Screen](https://user-images.githubusercontent.com/63957920/107955260-95f37b80-6fc3-11eb-8862-4e0668c6d6e1.jpeg)  |    ![About Page](https://user-images.githubusercontent.com/63957920/107955159-76f4e980-6fc3-11eb-87f8-464d6e9b9db4.jpeg)     |
+| ![Change Password Page](https://user-images.githubusercontent.com/63957920/107955177-7bb99d80-6fc3-11eb-8a61-729001a3c330.jpeg)  | ![Logout Screen Page](https://user-images.githubusercontent.com/57872757/126679249-89fb62d3-8dd0-4ec8-a8f5-865d92df57bb.jpg) |
+
 ## Contact
 
 You can reach our community at [AnitaB.org Open Source Zulip](https://anitab-org.zulipchat.com/).