Skip to content

A library that thoroughly gathers detailed information about the administrative divisions, districts, sub-districts, unions, and related geographical entities in Bangladesh.

License

Notifications You must be signed in to change notification settings

rakibhasan1030/LocaleCraftBD

Repository files navigation

Locale Craft BD MIT License Maven Central

This initiative focuses on providing fundamental insights into Bangladesh, particularly covering details about its administrative structure in both English and Bengali languages. The aim is to present comprehensive information in a clear and accessible manner for a broad audience.

🛠️ Installation

LocaleCraftBD is installed by adding the following dependency to your build.gradle file:

repositories {
  mavenCentral()
}

Gradle Groovy DSL

dependencies {
  implementation 'io.github.rakibhasan1030:bd-navigator:1.0.1'
}

Gradle Kotlin DSL

dependencies {
  implementation("io.github.rakibhasan1030:bd-navigator:1.0.1")
}

Apache Maven

<dependency>
  <groupId>io.github.rakibhasan1030</groupId>
  <artifactId>bd-navigator</artifactId>
  <version>1.0.1</version>
  <type>aar</type>
</dependency>

⚙️ Usage

To begin with LocaleCraftBD you've to simply call the DivisionInfo class, it'll return a list of string which contain all the division list.
Example:

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContent {
            // Apply the custom theme defined in LocaleCraftBDTheme
            LocaleCraftBDTheme {
                Surface(
                    modifier = Modifier.fillMaxSize(),
                    color = MaterialTheme.colorScheme.background
                ) {
                    // Initialize an instance of DivisionInfo for navigating through divisions
                    val navigator = DivisionInfo()

                    // Log Division List in Bangla and English
                    Log.v("TAG", "Division List in Bangla : ${navigator.getDivisionsBn()}")
                    Log.v("TAG", "Division List in English : ${navigator.getDivisionsEn()}")

                    // Log District List in Bangla and English
                    Log.v("TAG", "District List in Bangla : ${navigator.getDistrictsBn()}")
                    Log.v("TAG", "District List in English : ${navigator.getDistrictsEn()}")

                    // Log Upazila List in Bangla and English
                    Log.v("TAG", "Upazila List in Bangla : ${navigator.getUpazilasBn()}")
                    Log.v("TAG", "Upazila List in English : ${navigator.getUpazilasEn()}")

                    // Log Union List in Bangla and English along with the count
                    Log.v("TAG", "Union List in Bangla : ${navigator.getUnionsBn().size}")
                    Log.v("TAG", "Union List in English : ${navigator.getUnionsEn()}")
                }
            }
        }
    }
}

✍️ Authors

🌱 Contributions

Contributions are always welcome!

🛡️ License

Copyright (c) 2023 Rakib Hasan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

A library that thoroughly gathers detailed information about the administrative divisions, districts, sub-districts, unions, and related geographical entities in Bangladesh.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages