Download the PHP package creasi/laravel-nusa without Composer

On this page you can find all versions of the php package creasi/laravel-nusa. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of creasi/laravel-nusa

Informations about the package laravel-nusa

Version License Actions Status

Creasi Nusa

Simple library aims to provide Indonesia Administrative Region Data based including the coordinates and postal codes, that easily integrated with our laravel project.

Requirements

Why?

Why don't just use existsing laravolt/indonesia, you may ask? That packages have been around for quite sometimes and already 've been used by hundreds of people, indeed. But, we need a package that ready-to-use once its installed.

I've been using edwardsamuel/Wilayah-Administratif-Indonesia for a while and put some contributions there, but it seems no longer maintained since 2018. More over its built for python not PHP.

That's why we choose cahyadsn/wilayah it has robust and strong database in terms of legality, but its not actually a package that can be installed as dependency. By that said, it has some work to-do.

We also found that w3appdev/kodepos provides better database structures that can easily mapped with databases from cahyadsn/wilayah in single query. Until we decided to swap it with cahyadsn/wilayah_kodepos due to #41.

Our takes for the words "easily integrated" and "ready-to-use once its installed" means we shouldn't dealing with the data migration and seeding, hence Indonesia isn't a small country, right? running seeder for such amount of data can takes quite some times to proceed let alone the app seeder.

Why PHP >=8.1 and Laravel >=10.0, you may ask? Because, why not!

Installation

That's all

Roadmaps

Usage

Thankfully Laravel provides us convenience way to have some sort of "relations" regardless of the database engine. So we can have this administrative data shipped in sqlite data and once we install it, then all we need is use it from our project with convenience of eloquent models.

ReSTful API

Models

This library comes with 4 primary models as follows :

Every models comes with similar interfaces, which mean every model has code and name field in it, you can also use search() scope method to query model either by code or name. e.g:

Please note that only Province and Regency that comes with latitude, longitude and coordinates data, while Village comes with postal_code. That's due to what cahyadsn/wilayah provide us.

In that regard we expect that Province, Regency and District should have access of any postal_codes that available within those area, and we believe that might be helpful in some cases. And there you go

Base on our experiences developing huge variety of products, the most use cases we need such a data is to fill up address form. But the requirement is might be vary on every single project. For that reason we also provide the bare minimun of Address model that use your default db connection and can easily extended to comply with project's requirement.

In that case you might wanna use our WithAddresses or WithAdress trait to your exitsting model, like so

To be able to use Address model, all you need is to publish the migration, like so

Then simply run artisan migrate to apply the additional migrations.

Databases

The database structure documentation please consult to database/README.md.

Customization

By default, nusa will add another database.connections config to your project and use it as main database for all nusa's models, and you can customize it anyway.

  1. Publish nusa's config by running the following commands

  2. Add new database.connections with key of your creasi.nusa.connection, say you have

    So, you'll need

In term of extending Address model, please a look at creasi.nusa.addressable config if you wanna use your own implementation of Address model.

Notes

As of now, only connection name and table names are available to customize, also we only test it using sqlite driver. Let us know if you had any issue using another database drivers.

Contributing

  1. Clone the repo and cd into it

  2. Install dependencies

  3. Update workbench/.env as you desire

  4. Init the databases, here you have 2 options:

    1. Use your local MySQL server.

      All you need is create 2 database for testing and upstream as you define in workbench/.env file

      Once you've done, run the following command to import the upstream db.

    2. Use our provided docker compose.yaml by simply run the following command

      [!IMPORTANT] Make sure that the value of DB_HOST is set to service name on compose.yaml which is upstream

      The command will create all required database and run the nusa:import command for you, and use the following command to stop the container.

As you might noticed that we use 3 different databases to develop and maintain this library. Here's the explanation :

Once you've done with your meaningful contributions, run the following command to ensure everythings is works as expected.

[!IMPORTANT]

  • Commit Convention: This project follows Conventional Commits using @commitlint/config-conventional as standart, so make sure you install its npm dependencies.
  • Code Style: This project uses Laravel Pint with laravel preset as coding standard, so make sure you follow the rules.
  • Anytime you make a change on workbench/.env file, make sure to run composer testbench:purge.

Credits

License

This library is open-sourced software licensed under MIT license.

All versions of laravel-nusa with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-sqlite3 Version *
laravel/framework Version ^9.0|^10.0|^11.0|^12.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package creasi/laravel-nusa contains the following files

Loading the files please wait ....