Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grigorygerasimov/laravel-weather
Laravel package based on WeatherAPI
https://github.com/grigorygerasimov/laravel-weather
geolocation ip ipsearch laravel package php8 php82 php82x weather weather-api weather-data weather-forecast
Last synced: 13 days ago
JSON representation
Laravel package based on WeatherAPI
- Host: GitHub
- URL: https://github.com/grigorygerasimov/laravel-weather
- Owner: GrigoryGerasimov
- Created: 2023-06-05T06:51:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-18T11:10:21.000Z (over 1 year ago)
- Last Synced: 2025-01-19T10:48:04.386Z (13 days ago)
- Topics: geolocation, ip, ipsearch, laravel, package, php8, php82, php82x, weather, weather-api, weather-data, weather-forecast
- Language: PHP
- Homepage: https://packagist.org/packages/grigorygerasimov/laravel-weather
- Size: 311 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Laravel-Weather Package
Laravel package for weather and geo info based on WeatherAPI (JSON RestAPI only)
## Installation
The package can be installed via Composer:
`composer require grigorygerasimov/laravel-weather`
You don't need to register the package Service Provider - this will be done automatically once you install the package.
For publishing the package config please run the following command. There are also some example views and the package docs under the same tag.
`php artisan vendor:publish --tag=laravel-weather`
## Start
Once the package is installed and the config is published, you are free to use the package in your Laravel projects.
All you need to do is to use the Weather facade (GrigoryGerasimov\Weather\Facades\Weather) and build custom fluent interfaces, e.g.:
`Weather::api('forecast')->city('Prague')->forecastDays(3)->requireAQI(true)->requireAlerts(true)->requireTides(true)->lang('cs')->get();`
The *api()* method is mandatory, as it configures the relevant api method and api key.
By default the WeatherAPI Free plan key is used, however you can always adjust it in the [laravel-weather config](https://github.com/GrigoryGerasimov/laravel-weather/blob/main/config/weather.php), if you have your own WeatherAPI key.
As for the api methods, the following ones are available.
```
current
forecast
search
history
marine
future
timezone
sports
astronomy
ip
```
By default, the *current* method is used. Please note that the default WeatherAPI Free plan key is limited for the *history* method.
The available Weather facade methods are:
```
api(string $type = 'current')
coords(float|string $lat, float|string $lon)
city(string $city)
zip(string $zipCode)
metar(string $metarCode)
iata(string $iataCode)
autoIp()
ip(string $ip)
forecastDays(int $days = 1)
historyFutureDate(string $date)
historyDate(string $date)
forecastHistoryTimestamp(string|int $timestamp)
historyTimestamp(string|int $timestamp)
forecastHistoryHour(int $hour)
requireAlerts(bool $shouldAlert = false)
requireAQI(bool $ifAqi = false)
requireTides(bool $ifTides = false)
withInterval()
lang(string $langCode)
get()
uri()
```
The facade method *get()* will provide you with the result of your request, however you can also access the request uri directly via the *uri()* method.
For demonstration purpose, the package also includes a number of components and views to the basic Weather api methods. These views are some very simple data lists without any particular styling, they serve merely for the visual representation of the weather and geo info retrieved with the help of this package. You can check them out under the following [web-routes](https://github.com/GrigoryGerasimov/laravel-weather/blob/main/routes/web.php)
For further details, you can also check the weather [controller](https://github.com/GrigoryGerasimov/laravel-weather/blob/main/src/Http/Controllers/WeatherController.php) and [components](https://github.com/GrigoryGerasimov/laravel-weather/tree/main/views/weather/components)
## Documentation
For the detailed infos on the package structure and api, please refer to the [Laravel-Weather documentation](https://github.com/GrigoryGerasimov/laravel-weather/tree/main/docs) which is published into your public folder. While running the php artisan serve command, you can access the docs as follows:
`http://localhost:8000/vendor/laravel-weather/docs/index.html`
Please don't forget to refer to the [official WeatherAPI documentation](https://www.weatherapi.com/docs/) to get a better glimpse of the weather and geo data via a JSON RestAPI.
## License
The package is under MIT license, thus you are free to use it in your projects.
## Feedback
As I've never had any previous experience in creating packages, I would appreciate some feedback: whether the Laravel-Weather package is easy/hard to use, what can be improved etc.
Feel free to get in touch with me under **[email protected]**