sanxy/journalapp

Google Africa Scholarship challenge course to create a Journal Android Application #7DaysofCodeChallenge

Journal App

Journal app is an open source application for android devices in respect to Google Africa Scholarship challenge course (#7DaysofCodeChallenge). This project was finished within seven days. The android application can be used to take notes, set alarm for important journals. Registration, login and password reset is based on Firebase Authentication while the journals are saved using ROOM (a persistence library) . Data are stored on the device.

Getting Started

• Download and install the apk file on your android device running on android operating system 4.4 and above.
• Register with a Gmail and login to enjoy the features of this Journal App.
• Internet access is required to register or login.
• New or Existing Google Account

Prerequisites

Your android application must be running on operating system 4.2 and above

• IDE (Android Studio)
• Java 8
• Android SDK

Installing

• Download the apk and install
  

For personal customization;
* Download and install Android Studio * Download neccessary SDK and Java components * Add Firebase Authentication, core and database * Add Google Play Services * Also add Room Persistence

Running The Tests

This android application has been tested on android running on 4.2, 4.4, 6.0 and 7.0 and various devices

Features

Currently the following functions are implemented:

• Register, login, password reset and logout functions
• Material Design interface *Basic add, modify and delete journal actions
• Today, upcoming and done/missed journals
• Manage your journals using alarms and categories
• Set priority for your journal
  

Deployment

Any android device

Author

Yusuf Adefolahan

Acknowledgments

• Google
• Udacity
• Andela
• ALC 3.0
• Google Africa Scholarship

License

Journal App is made available under the terms of the MIT License.

MIT License

Copyright (c) 2018-2019 Yusuf Adefolahan

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.