https://github.com/shubhamdeepkeshav/my-note-app

https://github.com/shubhamdeepkeshav/my-note-app

Last synced: 27 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/shubhamdeepkeshav/my-note-app
• Owner: shubhamdeepkeshav
• Created: 2025-04-18T06:36:04.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2025-04-18T06:56:19.000Z (about 2 months ago)
• Last Synced: 2025-04-18T19:57:58.516Z (about 1 month ago)
• Language: Kotlin
• Size: 158 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 📱 My Android App

A modern Android application built using **Kotlin**, **Gradle Kotlin DSL**, and **Jetpack libraries**. Designed with best practices like `ViewModel`, `LiveData`, and AndroidX support.

---

## 🚀 Features

- ✅ Written in Kotlin

- 🛠️ Uses Gradle Kotlin DSL (`build.gradle.kts`)

- 💡 AndroidX & Jetpack libraries enabled

- 📦 Optimized JVM build settings

- 🧩 Modular & scalable project structure

---

## 🛠️ Tech Stack

- **Kotlin** — Modern, expressive, and safe programming language

- **AndroidX** — Backward-compatible Android libraries

- **Gradle Kotlin DSL** — Type-safe Gradle build scripts

- **Jetpack Components** — ViewModel, LiveData, etc.

- **Room** (if used) — Local database support

---

## 📁 Project Structure

. ├── .gitignore ├── gradle.properties ├── gradlew / gradlew.bat ├── build.gradle.kts ├── settings.gradle.kts └── app/ (source code folder)

---

## ⚙️ Gradle Configuration Highlights

From `gradle.properties`:

- `org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8`  

  ➤ Boosts JVM heap size for better build performance

- `android.useAndroidX=true`  

  ➤ Ensures AndroidX compatibility

- `kotlin.code.style=official`  

  ➤ Applies official Kotlin code style

- `android.nonTransitiveRClass=true`  

  ➤ Generates leaner R classes

---

## 🧪 How to Run

1. Open the project in **Android Studio**

2. Sync Gradle when prompted

3. Build and run on your device or emulator

![Image](https://github.com/user-attachments/assets/a2af9900-d340-4308-a2a3-72652c8da2de)

![Image](https://github.com/user-attachments/assets/8b9a33fb-207b-43b7-abbd-46463ffc62ff)

---

## ✅ Requirements

- Android Studio **Electric Eel** or later

- Android SDK **33+**

- Kotlin **1.9+**

- Gradle **8.0+**

---

## 🤝 Contributing

Want to contribute? Fork the repo, make your changes, and open a pull request. Contributions and feedback are welcome!

---

## 📃 License

This project is licensed under the [MIT License](LICENSE).

---