README

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.

Requirements

PHP 8.3+
Laravel 11+

Get to know us

Installation

Install the package via Composer:

composer require raiolanetworks/atlas

Optionally publish the config file to customise table names or toggle entities:

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

Run the migrations and seed the database:

php artisan atlas:install

The command will migrate the tables for every entity enabled in config('atlas.entities') (all enabled by default) and let you choose which seeders to run. The process may take a few minutes due to the large number of cities.

To re-seed the data after a package upgrade:

php artisan atlas:update

Other publishable resources

php artisan vendor:publish --tag="atlas-translations"
php artisan vendor:publish --tag="atlas-jsons"        # JSON data files (for overriding)

Note: Migrations are auto-loaded by the package. Do not publish them with --tag="atlas-migrations" unless you have a specific reason — published copies will cause "table already exists" errors.

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
	{
		return Country::where('region_name', 'Africa')
			->orderBy('name')
			->get();
	}
}

Upgrading

If you are upgrading from 1.x, please see UPGRADE.md for a list of breaking changes and migration steps.

raiolanetworks / atlas

Maintainers

Details