Shaky 📳

Your Vibration Detection Companion.
By activating Shaky as your Earthquake Detector, you can sleep peacefully, knowing that it's vigilantly Detecting and will Alert you to any tremors.

Get it on Play Store here
Supported by The White Wings🪽. Play Store link

Navigate Your Journey of exploring Shaky 🗺️

1. Inspiration & Goal - The Story Behind Shaky
2. Quick Start
3. Usage
4. Demonstration
5. Utilized Technologies
6. Main Files
7. Links to Check Out

Inspiration & Goal - The Story Behind Shaky 💡

In 2023, Turkey and Syria were rocked by a devastating earthquake, followed by over 30,000 aftershocks. The catastrophe affected more than 14 million people, resulting in widespread damage and loss of life.
My brother shared stories of some friends too frightened to sleep, worried they wouldn't have time to respond to potential tremors.

To assist them facing such situations, he inspired me to create an app. This app should provide peace of mind by detecting vibrations and alerting the user to take precautions.
So, I set out to create Shaky. My goal was to design an app that anyone could use effortlessly anywhere, ensuring that everyone could benefit from its capabilities.

Quick Start 🚀

Clone the Repository or Download Shaky from Play Store, and Run the app on your device or emulator.

After that:

1. Start Detection: The detector will start monitoring automatically.
2. Enable Notifications: Upon opening the app, grant permission for notifications.
   This allows Shaky to alert you when vibrations are detected.

• To Stop Detection: Tap the OFF button at the middle of the screen.
• Set Sensitivity: Adjust the sensitivity level of the vibration detector with the Sensitivity slider. More instructions in the Usage section.
• Adjust Alarm Volume: Set the volume level for the alert alarm.
  Choose a volume that ensures you'll wake up or be alerted during vibrations.

Usage 📱

• Multilingual support: Available in English, Arabic, and Turkish.
  It correspondes to your device language.
• Monitoring Vibrations: After openning Shaky, it will start monitoring vibrations automatically.
  Keep the app running in the background, and it will continuously detect any vibrations.
• You can return to Shaky effortlessly through its Notification.

Interacting with the Main Screen:

• Status Indicator: Check the status indicator on the main screen to see if the app is actively monitoring vibrations.
• Start/Stop Detection: Use the ON/OFF buttons to start or stop vibration monitoring.
• Adjust Sensitivity: Slide the Sensitivity slider to customize the detector's sensitivity level.
  Start with the maximum sensitivity and adjust it gradually to suit your preference. You can increase sensitivity to detect weaker vibrations or decrease it to avoid false alarms.
• Adjust Alarm Volume: Slide the Alarm volume slider to set your preferred alarm volume level.
• Access Additional Functions: Tap the button on the bottom right corner of the main screen to access more functions.

Accessing Additional Features:

• Changing Alarm Tone: Customize the alarm tone by tapping on the corresponding button and selecting from available options.
• Providing Feedback: Share your thoughts or report issues by tapping on the feedback button, which will direct you to your preferred email app.
• Accessing Important Notes: Navigate to the Notes Screen by tapping on the corresponding button.

On the Notes Screen:

• You will find essential notes about using the app. Here, you'll discover instructions on overcoming common obstacles you may face, such as background operation disruptions.
• Additiaonally you'll find a reference to the app's Privacy Policy.

Ensuring proper app functionality when the screen turns off ❕

• Apps running in the background may be halted by the Android system for battery preservation. This could lead to disruptions in app functionality shortly after your screen turns off.
• To prevent such occurrences, you should adjust specific settings based on your device's manufacturer and Android version. While this process may seem challenging in some cases, unfortunately, these settings can only be modified manually by the user.
• To overcome this obstacle, click the "Let's fix it" button on the dialog that appears upon app launch, or refer to the "Background Operation Explanation" note in the "Important Notes" section. You'll find step-by-step guides to assist you in rectifying this situation.

Shaky operates offline and features a straightforward UI, making it accessible for Everyone Anytime, Anywhere.

Demonstration 📸

Click the image below to watch the full app demo on YouTube ⬇️

Utilized Technologies 🔧

• Programming Language: Java

• Frameworks/Libraries:

  • Accelerometer: For vibrations detection.
  • Motion Layout: For creating smooth animations.
  • SharedPreferences: For storing and retrieving user's preferred detector sensitivity, and alarm tone.

• Development Tools: Figma, Lottie Animations, Git, and Android Studio.

Main Files 📁

• MainActivity.java
• activity_main.xml
• activity_main_scene.xml
  
  
• MediaAndSensorService.java
• AndroidManifest.xml
  
  
• MoreFragment.java
• NotesFragment.java
• fragment_more.xml
• fragment_notes.xml

Links to Check Out: 👍

• My Developer Page at Play Store
• Shaky at Play Store
• Shaky on YouTube

When the ground gets shaky, Shaky has got you 🛡️