Digital Diary

Digital Diary is an Android application that allows users to create, edit, and manage diary entries with text, images, audio recordings, and location data. This project is developed using Kotlin, Dagger Hilt for dependency injection, Room for database management, and Google Maps API for location features. The application was created as part of the PRM (Mobile Programming) course at PJATK.

Features

• Add, edit, and delete diary entries
• Attach images to entries from the gallery or camera
• Record and attach audio notes to entries
• Automatically capture the user's location and display it on a map
• Persist data locally using Room database
• Dependency injection using Dagger Hilt
• PIN code setup and authentication to secure the application

Screenshots

Login Screen

Main Screen

Add Entry

Edit Entry

Delete Entry

Installation

1. Clone the repository:

   git clone https://github.com/szwedzik/digital-diary.git

2. Open the project in Android Studio.

3. Build the project to install all dependencies.

4. Run the project on an Android emulator or a physical device.

Prerequisites

• Android Studio Arctic Fox or later
• Android SDK 30 or later
• Google Maps API key (add to AndroidManifest.xml file):

<meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="YOUR_GOOGLE_MAPS_API_KEY"/>

Dependencies

• Dagger Hilt for dependency injection
• Room for database management
• Google Maps for location services
• Kotlin Coroutines for asynchronous programming

Getting Started

Setting Up Dependency Injection

We use Dagger Hilt for dependency injection to provide instances of the Room database, DAOs, and other utilities.

@Module
@InstallIn(SingletonComponent::class)
object AppModule {

    @Provides
    @Singleton
    fun provideDiaryEntryDatabase(
        @ApplicationContext appContext: Context
    ): DiaryEntryDatabase {
        return DiaryEntryDatabase.getDatabase(appContext)
    }

    @Provides
    @Singleton
    fun provideDiaryEntryDao(database: DiaryEntryDatabase): DiaryEntryDao {
        return database.diaryEntryDao()
    }

    @Provides
    @Singleton
    fun providePinDao(database: DiaryEntryDatabase): PinDao {
        return database.pinDao()
    }

    @Provides
    @Singleton
    fun provideLocationUtils(
        @ApplicationContext appContext: Context
    ): LocationUtils {
        return LocationUtils(appContext)
    }
}

Initializing Sample Data

We initialize the database with sample data to showcase the application's functionality.

object AppInitializer {

    fun initializeDatabase(context: Context) {
        val database = DiaryEntryDatabase.getDatabase(context)
        val diaryEntryDao = database.diaryEntryDao()
        val pinDao = database.pinDao()


        CoroutineScope(Dispatchers.IO).launch {

            diaryEntryDao.deleteAllEntries()
            pinDao.deleteAllPins()

            val initialEntries = listOf(
                DiaryEntry(
                    title = "Warsaw #1",
                    content = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc in ex mollis, placerat erat et, lobortis enim. Sed vitae ante venenatis, consequat eros vel, laoreet odio. Donec tincidunt felis in semper vehicula. Sed id finibus erat, vel dignissim erat. Mauris ullamcorper lectus a dui elementum blandit. Nulla eget ornare enim. Maecenas a dui augue. Nunc laoreet mattis arcu, a scelerisque leo. Sed in urna in risus imperdiet accumsan sed ut nulla. Vivamus quis nibh enim. Aenean dignissim ornare lectus, sit amet suscipit turpis accumsan vitae. Pellentesque euismod, nisl sit amet porta tempus, magna odio semper ex, sit amet gravida velit nibh vitae eros. Aliquam nisi est, pellentesque in semper venenatis, lacinia vitae orci.",
                    imageUri = "",
                    audioUri = "",
                    latitude = 52.237049,
                    longitude = 21.017532,
                    createdTime = Date().time,
                    updatedTime = null
                ),
                DiaryEntry(
                    title = "New York #1",
                    content = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc in ex mollis, placerat erat et, lobortis enim. Sed vitae ante venenatis, consequat eros vel, laoreet odio. Donec tincidunt felis in semper vehicula. Sed id finibus erat, vel dignissim erat. Mauris ullamcorper lectus a dui elementum blandit. Nulla eget ornare enim. Maecenas a dui augue. Nunc laoreet mattis arcu, a scelerisque leo. Sed in urna in risus imperdiet accumsan sed ut nulla. Vivamus quis nibh enim. Aenean dignissim ornare lectus, sit amet suscipit turpis accumsan vitae. Pellentesque euismod, nisl sit amet porta tempus, magna odio semper ex, sit amet gravida velit nibh vitae eros. Aliquam nisi est, pellentesque in semper venenatis, lacinia vitae orci.",
                    imageUri = "",
                    audioUri = "",
                    latitude = 40.758896,
                    longitude = -73.985130,
                    createdTime = Date().time,
                    updatedTime = null
                ),
                DiaryEntry(
                    title = "Moscow #1",
                    content = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc in ex mollis, placerat erat et, lobortis enim. Sed vitae ante venenatis, consequat eros vel, laoreet odio. Donec tincidunt felis in semper vehicula. Sed id finibus erat, vel dignissim erat. Mauris ullamcorper lectus a dui elementum blandit. Nulla eget ornare enim. Maecenas a dui augue. Nunc laoreet mattis arcu, a scelerisque leo. Sed in urna in risus imperdiet accumsan sed ut nulla. Vivamus quis nibh enim. Aenean dignissim ornare lectus, sit amet suscipit turpis accumsan vitae. Pellentesque euismod, nisl sit amet porta tempus, magna odio semper ex, sit amet gravida velit nibh vitae eros. Aliquam nisi est, pellentesque in semper venenatis, lacinia vitae orci.",
                    imageUri = "",
                    audioUri = "",
                    latitude = 55.751244,
                    longitude = 37.618423,
                    createdTime = Date().time,
                    updatedTime = null
                ),
                DiaryEntry(
                    title = "Washington DC #1",
                    content = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc in ex mollis, placerat erat et, lobortis enim. Sed vitae ante venenatis, consequat eros vel, laoreet odio. Donec tincidunt felis in semper vehicula. Sed id finibus erat, vel dignissim erat. Mauris ullamcorper lectus a dui elementum blandit. Nulla eget ornare enim. Maecenas a dui augue. Nunc laoreet mattis arcu, a scelerisque leo. Sed in urna in risus imperdiet accumsan sed ut nulla. Vivamus quis nibh enim. Aenean dignissim ornare lectus, sit amet suscipit turpis accumsan vitae. Pellentesque euismod, nisl sit amet porta tempus, magna odio semper ex, sit amet gravida velit nibh vitae eros. Aliquam nisi est, pellentesque in semper venenatis, lacinia vitae orci.",
                    imageUri = "",
                    audioUri = "",
                    latitude = 38.894207,
                    longitude = -77.035507,
                    createdTime = Date().time,
                    updatedTime = null
                )
            )
            diaryEntryDao.insertAll(initialEntries)
        }
    }
}

Key Components

AddEntryActivity

Handles adding new diary entries, capturing images, recording audio, and fetching the user's current location.

EditEntryActivity

Allows users to edit existing diary entries, including updating text, images, audio recordings.

PIN Code Setup and Authentication

The application includes functionality to set up and authenticate using a PIN code on the first launch to secure the app from unauthorized access.

Permissions

The application requires the following permissions:

• ACCESS_FINE_LOCATION
• ACCESS_COARSE_LOCATION
• CAMERA
• RECORD_AUDIO Permissions are requested at runtime for devices running Android M (API 23) or later.

private fun checkPermissions() {
    if (ContextCompat.checkSelfPermission(this, Manifest.permission.ACCESS_FINE_LOCATION) != PackageManager.PERMISSION_GRANTED ||
        ContextCompat.checkSelfPermission(this, Manifest.permission.ACCESS_COARSE_LOCATION) != PackageManager.PERMISSION_GRANTED ||
        ContextCompat.checkSelfPermission(this, Manifest.permission.CAMERA) != PackageManager.PERMISSION_GRANTED ||
        ContextCompat.checkSelfPermission(this, Manifest.permission.RECORD_AUDIO) != PackageManager.PERMISSION_GRANTED) {
        requestPermissions()
    } else {
        getLocation()
    }
}

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin feature/my-new-feature)
5. Create a new Pull Request

License

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