Skip to content

Latest commit

 

History

History
83 lines (66 loc) · 3.94 KB

README.md

File metadata and controls

83 lines (66 loc) · 3.94 KB
Raw

MaterialJournal

A journal application where in users can pen down their thoughts and feelings submitted for the "7 Days of code" challlenge for the GoogleAfiricaScholarship Challenge offered by Udacity and powered by Andela Learning Community (ALC) learners.

Screenshots

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

  • Android Studio 3.2
  • Java JDK

Installing

Follow this steps if you want get a local copy of the project in your machine.

1. Clone or fork the repository by running the cammand below

git clone https://github.com/YassinAJDI/MaterialJournal.git

2. Import the project in AndroidStudio

  1. In Android Studio, go to File -> New -> Import project
  2. Follew the dialog wizard to choose the folder where you cloned the project and click on open.
  3. Androidstudio imports the projects and builds it for you.

3. Add Firebase config

  1. Go to Firebase and click on + Add project to create a new project
  2. Add the SHA1 fingerprint of your machine after you have created the project
  3. Download google_service.json file and add to the /app folder of the project
  4. Clean -> Build the project and ensure that every thing works fine

You can now run the project in an Android Emulator or a real Android Device.

Note : A sample release apk is avaible Here

Built With

  • Android support Library - Android support Library 28
  • Room Database - The Room persistence library for Android.
  • Glide - An image loading and caching library for Android focused on smooth scrolling
  • Firebase - For authentication and data persisntence.

Authors

  • Yassin AJDI

License

MIT License

Copyright (c) 2018 Yassin Ajdi

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.