Skip to content

Latest commit

 

History

History
executable file
·
90 lines (54 loc) · 2.73 KB

README.md

File metadata and controls

executable file
·
90 lines (54 loc) · 2.73 KB
Raw

Get the data from the most recondite place with 'Atlas'

With 'Atlas' you will be able to create new tables in the database and fill them with information about countries, states, cities, timezones and more.

Get to know us

Installation

You can install the package via composer:

composer require raiolanetworks/atlas

You can publish the migrations with:

php artisan vendor:publish --tag="atlas-migrations"

Also, you can publish the config file with:

php artisan vendor:publish --tag="atlas-config"

Finally, you can publish the data jsons file with:

php artisan vendor:publish --tag="atlas-jsons"

For run the migrations and fill the tables you should run:

php artisan atlas:install

This will migrate the database tables previously allowed in the configuration file in the entities section. (By default, all are allowed)

When the command is executed, it will give the option to select which seeders to run.

The process may take a few minutes as the number of cities is very large.

Usage

Internally, the package works with Laravel models, which allows you to work with this model as if they were models of your own project.

For example, if you want to get all the countries in Africa:

use Raiolanetworks\Atlas\Models\Country;

class MyClass
{
	public function getAllAfricaCountries(): Collection
	{
		Country::whereRegion('Africa')
			->orderBy('name')
			->get();
		}
}

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

License

The MIT License (MIT). Please see License File for more information.