https://github.com/sharpapi/nova-ai-translator
Laravel Nova 4 AI-powered translation Action with SharpAPI.com
https://github.com/sharpapi/nova-ai-translator
ai composer-package laravel laravel-package nova nova-extension nova-pack package translation
Last synced: about 1 month ago
JSON representation
Laravel Nova 4 AI-powered translation Action with SharpAPI.com
- Host: GitHub
- URL: https://github.com/sharpapi/nova-ai-translator
- Owner: sharpapi
- License: mit
- Created: 2024-11-10T13:18:01.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-04-08T05:17:49.000Z (about 1 month ago)
- Last Synced: 2025-04-08T06:24:11.347Z (about 1 month ago)
- Topics: ai, composer-package, laravel, laravel-package, nova, nova-extension, nova-pack, package, translation
- Language: PHP
- Homepage: https://sharpapi.com/en/blog/post/effortless-translations-with-ai-in-laravel-nova
- Size: 330 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SharpAPI AI Translator for Laravel Nova
[](https://packagist.org/packages/sharpapi/nova-ai-translator)
[](https://packagist.org/packages/sharpapi/nova-ai-translator)
Welcome to **SharpAPI AI Translator for Laravel Nova** – the package that’s here to make your content translation smoother and smarter with the power of SharpAPI's [Advanced Text Translator AI API](https://sharpapi.com/en/catalog/ai/content-marketing-automation/advanced-text-translator) and to leverage [AI for Laravel](https://SharpAPI.com/). This package extends the already-awesome [Spatie's `laravel-translatable`](https://spatie.be/docs/laravel-translatable/) with a Nova action you can trigger from your resource’s edit or list views.
`🤖 Initiate AI Translation` can be run from either:
- **The Nova resources list view:**
> 
- **Or from the edit screen of an individual resource:**
> 
Here's the form you’ll use to dispatch the translation:
> 
## Requirements
- **Laravel**: ^9.0+
- **Laravel Nova**: 4.0+
- **PHP**: 8.0+
- **spatie/laravel-translatable**: used for detecting translatable fields
## Installation & Configuration
### 1. Install the package via Composer
```bash
composer require sharpapi/nova-ai-translator
```
### 2. API Key Configuration
You’ll need an API key from [SharpAPI.com](https://SharpAPI.com/). Add it to your `.env` file like so:
```
SHARP_API_KEY=your-sharp-api-key
```
### 3. Supported Locales Configuration
Add your supported locales in `config/app.php` under the `locales` key:
```php
return [
'locales' => [
'en' => 'English',
'es' => 'Spanish',
'fr' => 'French',
// Add other supported languages here
],
];
```
### 4. Add to Nova Resource Models
For any model you want to translate, make sure it:
- Uses Spatie’s `HasTranslations` trait.
- Specifies which attributes are `translatable`.
- **[OPTIONAL], yet Highly Recommended**: Use `Actionable` and `Notifiable` traits to track actions and notifications. This ensures you can log and monitor translation progress effectively.
Example:
```php
namespace App;
use Laravel\Nova\Actions\Actionable;
use Illuminate\Notifications\Notifiable;
use Spatie\Translatable\HasTranslations;
class BlogPost
{
use Actionable, Notifiable, HasTranslations;
protected $translatable = ['title', 'subtitle', 'content'];
}
```
### 5. Attach the Action in a Nova Resource
Add the `TranslateModel` action to any Nova resource, such as `BlogPost`:
```php
use SharpAPI\NovaAiTranslator\Actions\TranslateModel;
public function actions()
{
return [
(new TranslateModel())->enabled(),
];
}
```
### 6. Queue Setup
The `TranslateModel` action runs as a queued job, which is essential for smooth, asynchronous processing. Make sure your app’s queue is up and running for best results.
## Using the TranslateModel Action
- From the resource’s edit screen, trigger the `TranslateModel` action.
- A form will pop up where you can select the source and target languages and choose an optional tone.
- **Note**: The action checks if all target language fields already contain content. If they do, you’ll be prompted to clear these fields first if you want a fresh AI-generated translation.
- Once triggered, the action queues the job, and you can monitor its progress if your model uses the `Actionable` and `Notifiable` traits.
### Tips
- **Translation logs**: Helpful for tracking what was translated.
> 
- **Error handling**: With `Laravel\Nova\Actions\Actionable`, you get detailed logs if something goes awry.
> 
## Changelog
See [CHANGELOG](CHANGELOG.md) for recent updates.
## Credits
- [A2Z WEB LTD](https://github.com/a2zwebltd)
- [Dawid Makowski](https://github.com/makowskid)
- Powered by [SharpAPI](https://sharpapi.com/) – your go-to for leveling up with [AI in Laravel](https://sharpapi.com/en/tag/laravel).
## License
Licensed under the MIT License – see the [License File](LICENSE.md) for details.
## Follow SharpAPI for More!
Stay tuned for updates, tips, and tricks:
- [SharpAPI X (formerly Twitter)](https://x.com/SharpAPI)
- [SharpAPI YouTube](https://www.youtube.com/@SharpAPI)
- [SharpAPI Vimeo](https://vimeo.com/SharpAPI)
- [SharpAPI LinkedIn](https://www.linkedin.com/products/a2z-web-ltd-sharpapicom-automate-with-aipowered-api/)
- [SharpAPI Facebook](https://www.facebook.com/profile.php?id=61554115896974)