Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laravel-backpack/translation-manager
UI for the admin to quickly translate multi-language Laravel applications.
https://github.com/laravel-backpack/translation-manager
Last synced: about 18 hours ago
JSON representation
UI for the admin to quickly translate multi-language Laravel applications.
- Host: GitHub
- URL: https://github.com/laravel-backpack/translation-manager
- Owner: Laravel-Backpack
- License: mit
- Created: 2024-03-23T17:46:30.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-02T12:09:03.000Z (about 1 month ago)
- Last Synced: 2024-12-28T22:36:29.905Z (6 days ago)
- Language: PHP
- Homepage:
- Size: 69.3 KB
- Stars: 31
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license.md
Awesome Lists containing this project
README
# Translation Manager
[![Total Downloads][ico-downloads]][link-downloads]
[](https://github.com/the-whole-fruit/manifesto)
Translation Manager provides a simple user interface to help you deal with translations in your Backpack application.
At a quick glance, some of the most relevant features are:
- View a list of all translations present in your application's language files.
- Edit translations directly from the interface.
- Search and filter translations for easy management.
This package uses the battle tested [spatie/laravel-translation-loader](https://github.com/spatie/laravel-translation-loader) under the hood.
## Preview
## Demo
Try it right now, edit some translations in [our online demo](https://demo.backpackforlaravel.com/admin/translation-manager).
## Installation
In your Laravel + Backpack project:
**1) Install the package using Composer**:
```bash
composer require backpack/translation-manager
```
**2) Configure the application**
> _If you already had [spatie/laravel-translation-loader](https://github.com/spatie/laravel-translation-loader) installed and configured, you can skip to the next step. Otherwise, follow along._
2.1) In your `config/app.php` you must replace Laravel's translation service provider:
```diff
-Illuminate\Translation\TranslationServiceProvider::class,
+Spatie\TranslationLoader\TranslationServiceProvider::class,
```
2.2) You must publish and run the migrations to create the `language_lines` table:
```bash
php artisan vendor:publish --provider="Spatie\TranslationLoader\TranslationServiceProvider" --tag="migrations"
php artisan migrate
```
**3) Optional setup options**
3.1) Add a menu item to `menu_items.blade.php` for easy access:
```bash
php artisan backpack:add-menu-content ""
```
3.2) Publish the config files:
```bash
php artisan vendor:publish --provider="Spatie\TranslationLoader\TranslationServiceProvider" --tag="config"
php artisan vendor:publish --provider="Backpack\TranslationManager\AddonServiceProvider" --tag="config"
```
**NOTE:** We highly recommend you to use this package alongside [Language Switcher](https://github.com/Laravel-Backpack/language-switcher) package, so that you can easily switch between languages in your panel.
## Usage
### List View:
The list view displays a comprehensive list of all translations within your application translation folder (usually `lang/`). Please do note that translations in `lang/vendor/xxx` folders are not possible to translate using this package.
Additionally, if you have [Backpack Pro](https://backpackforlaravel.com/products/pro-for-unlimited-projects) installed, your admin can also see and use the filters, to quickly narrow down translations.
### Edit View
Any translation can be edited by clicking the Edit button. It will open a page where the admin can input the new value, for all languages.
Once edited, the changes are saved to the database for persistence. All translations on the database have priority over the ones in the language files. This means that you can safely let your admin edit translations, in production. Your auto-deploys will continue working, because no files get edited, only DB entries.
### Editable Columns
If you have the [Editable Columns](https://backpackforlaravel.com/products/editable-columns) package installed, the admin can directly edit translations within the List View. This provides an excellent UX - because they can translate everything much much faster, without having to switch pages.
If you don't want that behavior you can disable it in the `config/backpack/translation-manager.php` file by setting `use_editable_columns => false`.
If you don't find that file, see above the optional steps to publish the config files.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Antonio Almeida](https://github.com/promatik)
- [Pedro Martins](https://github.com/pxpm)
- [Cristian Tabacitu](https://github.com/tabacitu)
- [All Contributors][link-contributors]
## License
This project was released under MIT License, so you can install it on top of any Backpack & Laravel project. Please see the [license file](https://backpackforlaravel.com/products/translation-manager/license.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/backpack/translation-manager.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/backpack/translation-manager.svg?style=flat-square
[link-author]: https://github.com/laravel-backpack
[link-contributors]: ../../contributors
[link-downloads]: https://packagist.org/packages/backpack/translation-manager