https://github.com/hi-folks/laravel-dashboard-devto-tile

Dashboard Tile for retrieving your articles from DEV.to. This tile can be used on the Laravel Dashboard
https://github.com/hi-folks/laravel-dashboard-devto-tile

dashboard dashboard-tiles dashboard-widget laravel php

Last synced: 1 day ago
JSON representation

Dashboard Tile for retrieving your articles from DEV.to. This tile can be used on the Laravel Dashboard

• Host: GitHub
• URL: https://github.com/hi-folks/laravel-dashboard-devto-tile
• Owner: Hi-Folks
• License: mit
• Created: 2020-06-04T21:43:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-19T09:46:48.000Z (about 4 years ago)
• Last Synced: 2024-12-04T09:08:55.706Z (about 2 months ago)
• Topics: dashboard, dashboard-tiles, dashboard-widget, laravel, php
• Language: PHP
• Homepage: https://packagist.org/packages/hi-folks/laravel-dashboard-devto-tile
• Size: 83 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Tile for retrieving articles from DEV.to

[![Latest Version on Packagist](https://img.shields.io/packagist/v/hi-folks/laravel-dashboard-devto-tile.svg?style=flat-square)](https://packagist.org/packages/hi-folks/laravel-dashboard-devto-tile)

Tile for retrieving your articles from DEV.to.

This tile can be used on [the Laravel Dashboard](https://docs.spatie.be/laravel-dashboard).

## Installation

You can install the package via composer:

```bash

composer require hi-folks/laravel-dashboard-devto-tile

```

## Usage

In your dashboard view you use the `livewire:devto-tile` component.

```html

    

```

## Obtain your DEV.to API KEY

Go to https://dev.to/settings/account and create your API KEY.

You need to store your api key in your .env file.

Remember to avoid to commit .env file :)

THe key for storing your api key is: DEVTO_TILE_APIKEY

```

DEVTO_TILE_APIKEY="yourapikeyfromdevto"

```

In config/dashboard.php please, add:

```

'tiles' => [

        'devto' => [

            'configurations' => [

                'default' => [

                    'api_key' => env('DEVTO_TILE_APIKEY'),

                ],

            ],

            'refresh_interval_in_seconds' => 5,

        ],

    ],

```

In order to retrieve articles from DEV.to automatically, you need to schedule your command.

Go to Kernel.php file and add this line.

```php

$schedule->command("dashboard:fetch-data-from-devto-api", [])->everyFiveMinutes();

```

## The tile

If you completed the setup correctly you could see in your dashboard your new tile.

![Screenshot of the Tile with DEV.to articles](screenshot-tile.png)

## Testing

``` bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Credits

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.