Atlas

Laravel package providing comprehensive global data for your next project

Installation

To install the package, use Composer:

composer require laraverse/atlas

Optional: The service provider will automatically get registered. Or you may manually add the service provider in bootstrap/providers.php file:

return [
    // ...
    Laraverse\Atlas\AtlasServiceProvider::class
];

You should publish the models, migration, views, assets and the config files with:

php artisan vendor:publish --provider="Laraverse\Atlas\AtlasServiceProvider"

Note: After vendor files are published, access atlas config files in the project root. Enable or disable facilities via config/atlas/facilities.php.

return [
    'enabled' => [
        # Tables::CITIES, (By default, It's disabled due to its large data size)
        Tables::COUNTRIES,
        Tables::CURRENCIES,
        Tables::PAYMENT_METHODS,
        Tables::PAYMENT_PRODUCTS,
        Tables::STATES,
        Tables::TIMEZONES,
        Tables::CONTINENTS,
    ],
]

You should install the atlas with:

# It will setup the atlas to serve comprehensive global data.
php artisan atlas:install

Note: Seeding the data will take time due to its large size.

Usage

In your project file include the atlas client like below:

use Illuminate\Support\Collection;
use Laraverse\Atlas\Client;

class YourClass
{
    public function call(Client $client) : Collection
    {
        // Start using Atlas client.
        $client->getCurrencies();
    }
}

Documentation and Usage Instructions

You can access the built-in documentation module by navigating to `/atlas/docs` after setting up Atlas.

Alternatively, Check out the Documentation for detailed usage instructions.

Credits

License

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

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

theshreyanshpanchal/atlas