JournalApp

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

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.1.3

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/po10cio/JournalApp.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 debug apk is avaible in the Here

Running the tests

Journal App comes with both Instrumented tests and Unit tests.

Instrumentation tests

To run the instrumentaton tests, you need an Android Emulator or a real Android device. Once you have any of this, open a terminal in AndroidStudio and run the command below.

./gradlew connectedAndroidTest

Running Local Unit tests

You do not need any device (Emulator of real Android device) to run this test. To run this test, open a terminal and run the command shown below.

./gradlew test

Note : This project has Fastlane enabled, so if you like fastlane, you can list the lanes and select the one yu wish to run.

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Kotlin - Koltin for JVM
• Room Database - The Room persistence library for Android.
• Koin - A pragmatic lightweight dependency injection framework for Kotlin
• Firebase - For authentication and data persisntence.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Jerry Hanks

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• PurpleBooth - for the README.md template
• Arnaud Giuliani