Journaling App

This Android Studio application project was completed through one of my courses. I utilized the skills we discovered in Android Studio to execute a full-stack Journaling application using Firebase as our back-end source.

Project Scope

This application requires users to sign up and login in order to use the application. Users are free to create journal entries that get stored within the database system. They can also interact with accessibility features for editing and deleting personal information and entries.

Tech Stack

• Java: The programming language used within Android Studio to develop the app.
• Android Studio: The official integrated development environment (IDE) for Android application development.
• Firebase: Backend-as-a-Service (BaaS) providing real-time database, authentication, and cloud storage.

Features

• User Authentication: Sign up and login functionality for users to manage their accounts.
• Create Journal Entries: Users can create new journal entries.
• Read Journal Entries: Users can view their saved journal entries.
• Update Journal Entries: Users can edit existing journal entries.
• Delete Journal Entries: Users can delete unwanted journal entries.

Installation

Prerequisites

• Android Studio installed on your machine
• Firebase project set up with Firestore and Authentication enabled
• Git installed on your machine

Cloning the Repository

1. Open your terminal.
2. Navigate to the directory where you want to clone the repository.
3. Run the following command:

   git clone <Http.git Link>

Setting Up the Project

1. Open Android Studio.
2. Select "Open an existing project" and navigate to the cloned repository.
3. Open the project in Android Studio.
4. Sync the project with Gradle files by clicking on Sync Project with Gradle Files.

Setting Up Firebase

1. Go to the Firebase Console.
2. Create a new project or use an existing project.
3. Add an Android app to your Firebase project.
4. Follow the instructions to download the google-services.json file.
5. Place the google-services.json file in the app/ directory of your project.
6. In the Firebase Console, enable Firestore and Authentication.

Running the Project

1. Connect your Android device or start an emulator.
2. Click on Run in Android Studio.
3. Select the target device and run the app.

Video Demonstration

Watch the video below to see how the application performs:

mp-demo-1_pfrau6Pe.mp4

Contributing

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch-name).
3. Make your changes and commit them (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature-branch-name).
5. Open a Pull Request.

Acknowledgments

• Thanks to Firebase for providing the backend services.