Journal App

Introduction

This is a simple Android Application. It's my final challenge as a receipient of 2018's Google Africa challenge scholarship.

As part of a 7-day coding challenge, we were tasked in the Intermediate Android Development track to build a simple app where users can pen down their thoughts and feelings. You can find more info on the challenge in this Google Doc.

Features

• Add / Modify journal entries
• Search for journal entries by title or content
• Google Sign in and Firebase Authentication
• Backup and sync using Firebase Cloud Firestore

Installation

You can install this app simply by downloading the debug build here.

• Make sure you enable installation from unknown sources
• Copy the file to a location on your Android device.
• Click on the file to start the installation process.

Building the Source Code

Alternatively, you can download the complete source code from here and build it from scratch.

What you'll need

• Android studio (this code was built using version 3.1.2, but anything above 2.0.0 should do)
• Source code
• A couple of minutes

Directions

• Download the source code either from here or by cloning using git:

  cd your_preferred_directory
  git clone https://github.com/josephdalughut/journal.git
  

• Fire up Android Studio and Open an existing Android Studio project

• Navigate to and select the downloaded project folder

• Add Firebase to your project

• Sync and build your project

• Build and Run the app on your emulator or device.

Testing

Units were test-driven

Unit Tests

• Android JUnit

• Roboletric

• Mockito

• Directory: /app/src/test

Instrumentation & UI Tests

A few Ui tests as well (however I mostly used Robolectric for testing UI units)

• Espresso

• Directory: /app/src/androidTest

Screenshots

License

MIT License

Copyright (c) 2018 Joey Dalu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Acknowledgements

• ALCWithGoogle 2018 Scholars for a fun and amazing time working together via slack and our meetups in Yola, Adamawa.
• Andela Learning Community For their constant support and for coordinating the program.
• Google & Udacity For the entire scholarship opportunity, course content and support during the program.

I learnt a lot during this program, and it's been an amazing experience.