README

What?

This package contains models, migrations and commands to automatically setup and update the administrative hierarchy of zip codes, municipalities and counties in Norway.

How

Install the package

composer require "tjenestetorget/norwegian-zip-codes"

Add service provider
Add NorwegianZipCodes\Providers\NorwegianZipCodesServiceProvider in config/app.php to the 'providers' array

Copy migrations to your migrations folder

php artisan vendor:publish --provider="NorwegianZipCodes\Providers\NorwegianZipCodesServiceProvider"

Run migrations

php artisan migrate

Seed the database

php artisan db:seed --class="NorwegianZipCodeSeeds"

Populate the database

php artisan zip_codes:update

Start using the models

	$zip_code     = \NorwegianZipCodes\Models\ZipCode::find('7340');
	$municipality = $zip_code->municipality;
	$county       = $municipality->county

ER diagram

Note

All IDs for counties, municipalities and zip_codes are strings. This is because officially the IDs are zero padded, fixed size. (4 for zip codes and municipalities, 2 for counties)