Tell us your story
Tell us your story
How has offline Wikipedia affected you? The Wikimedia Foundation (the non-profit that supports Wikipedia) is looking for personal, diverse and inspiring stories about how offline Wikipedia affects the world. If you have a personal story that you would like to share, please contact: stories@kiwix.org. Thank you!

Changes

Jump to: navigation, search

GSoC 2018

2,188 bytes added, 2 years ago
Ideas page improvements
As this is our first year proposing GSoC projects we have decided on four Android projects. The possible mentors for all these projects are: mhutti1, Kelson42, Rashiq, EladKeyshawn
== GSoC 2018 Ideas List ==
=== Improve the automated testing setup of the Kiwix Android applicationapps CI setup and increase our code coverage. ===
==== Summary: ====
We have a basic automated test setup for our Android appapplication using Travis Continuous Integration and Bitbar cloud testing. During this project you would be improving existing test infrastructure as well as writing new tests to help combat regressions in our code. As well as writing tests you would be refactoring parts of the code base to improve test-ability and readability.
==== Improvements to be made: ====
* Abstract large parts of the app Write new unit and instrumentation tests to improve code coverage.* Where needed make use dagger of dependency injection ein test implementations.g shared preferences* Use this Refactor code where needed to create more meaningful testsallow it to be unit tested and improve readability.* Specifically ensure the following areas are tested: Network, File System, Content Download, JNI interactions.* Improve stability of existing testsour CI build process to allow for quicker and more targeted testing.
==== Skills needed ====
* Android dev experience (Java).
* Experience with CI/Automated testing.
* Experience refactoring code.
* Experience with dependency injection techniques.
==== Skill Rating: Easy ==== === Improve android onboarding the Kiwix Android apps new user experience. ===
==== Summary: ====
The onboarding new user experience for Kiwix Android should be improved to allow users to More more easily find content that they are looking for, while also ensuring that they understand the functions that the application provides.The bug report process of the application should also be simplified in order to allow more information to be captured while preserving user privacy.
==== Improvements to be made: ====
* Create a new initial landing page with suggested ZIM filesthat a user might want to download.* Improve the download management UI and UX to flow more naturallyintuitively, guiding users to get the content that they want.* Implement various quality of life features to increase user retention.* Create a custom bug report setup to allow users to make their issues known report crashes and request features more easilydirectly while providing anonymous meta data if they wish.
==== Skills needed ====
* Android dev experience (Java).* Some UI designExperience writing initiative UIs. * HTML/CSS/JavaScript to make a simple web panel for issues?to capture bug reports from the app. ==== Skill Rating: Medium ====
=== Implement full multizim multi-zim support in the Kiwix Android app. ===
==== Summary: ====
Multizim Multi-zim search is currently an experimental app option. You would be implementing This task involves fleshing it fully With out and improving its stability, while also adding new features for use in Custom applications to improve user acquisition rates and save space on users devices by utilising cross ZIM zim file linking, auto download of extra content, combined with a more taylored intuitive searchexperience.
==== Improvements to be made: ====
* Improve search functionality to include an image and a snippetallowing users to see the context of their searches.* Implement a download page to download “predetermined content” that would work specifically with custom our prepackaged Custom apps.* Work with other team members to formalise spec for cross ZIM Urls.* Backup Implement a download mechanism to download for Custom appscontent linked from downloaded zim files and keep it up to date.
==== Skills needed ====
* Android dev experience (Java)
* Basic knowledge of the JNI.
* Some UI designexperience. ==== Skill Rating: Hard ====
=== Improve Custom Android App implementations . ===
==== Summary: ====
Our custom Custom apps are a great way for users to download a subset of the content that  they want without having to navigate through a list of daunting content. They are currently seeing rapid growth in adoption and we want without extra baggageto improve the experience for our users currently using them by increasing their stability.
==== Improvements to be made: ====
* Validate ZIM zim files from hashto ensure they are not corrupted.* Implement the recommended backup download solution using existing codeto fix corrupted files.
* Write a simple intuitive UI for this download solution.
* Research solutions for embedded ZIM zim files without unpacking the content from the APK and implement the most feasible solution.* Look into the best way to relocate/ share move OBB files if possiblewithin the file system of between devices and implement any feasible solutions found.
==== Skills needed: ====
* Basic knowledge of the JNI.
* Some UI design
 
==== Skill Rating: Hard ====
21
edits

Navigation menu