Skip to content

An android app built to provide easy access to various websites under the project Harukaze.

License

Notifications You must be signed in to change notification settings

kurtnettle/harukaze-android

Repository files navigation

Harukaze 🍃

License: GPL v3 Android Min SDK Target SDK Kotlin Jetpack Compose Ktor Koin LottieFiles Telegram Telegram

Harukaze (Japanese spring breeze) is an android app developed to provide easy access to various projects related to BUBT developed by me. Good bye to long unmemorable long URLs

Table of Contents

App Name Story

I struggled to find a name for the app, then I somehow turned to Japanese words and found one that resonated. It also aligned with the semester name (Spring 2025) I was in, making it feel like the perfect fit!

Screenshot 📷

Developing 💻

  1. Clone the repository:

    git clone https://github.com/kurtnettle

  2. Open in Android Studio

  3. Change the config url in utils/Constants.kt (Refer to data/models/AppConfig for JSON schema)

  4. Build the project

  5. Run on device 🚀

Contributing 🤝

I welcome contributions from the community! To contribute, please follow these steps:

  1. Fork the Repository: Create your own copy.

  2. Open an Issue: Report bugs or suggest features.

  3. Submit a Pull Request: Ensure your code is well-tested and follows project standards.

Support 💬

Need help or want to discuss issues? Join our Telegram group

Credits 🌟

Open-Source Libraries and Tools 🛠️

Android & Jetpack

  • AndroidX Core KTX: Kotlin extensions for core components
  • Jetpack Compose: Modern declarative UI toolkit
  • Android Lifecycle: Lifecycle-aware components
  • DataStore: Data storage solution

Third-Party Libraries

  • Koin: Dependency injection framework
  • Ktor: Asynchronous HTTP client
  • Timber: Advanced logging utility

UI Components

  • Material 3: Material Design components
  • Material Icons Extended: Extended icon pack
  • Lottie Compose: Animated vector graphics

Fonts

  • Google Fonts: Lora and Roboto

Testing

  • JUnit: Unit testing framework
  • Espresso: UI automation tests

Development Tools

  • Android Studio: IDE for Android development
  • Gradle: Build automation tool

Special thanks 🙌

For the tutorials

For the awesome free mockup generator

License 📜

This project is licensed under the GNU General Public License v3.0 (GPLv3). See the LICENSE file for full details.

By contributing, you acknowledge that your submissions will also be licensed under GPLv3.

About

An android app built to provide easy access to various websites under the project Harukaze.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages