lukasss93 / laravel-larex-crowdin
Laravel Larex Crowdin
Fund package maintenance!
Lukasss93
Installs: 1 646
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 1
Open Issues: 1
Requires
- php: ^8.0
- ext-json: *
- ext-simplexml: *
- crowdin/crowdin-api-client: ^1.7
- illuminate/support: ^8.0|^9.0
- loilo/fuse: ^6.4
- lukasss93/laravel-larex: ^4.0
Requires (Dev)
- orchestra/testbench: ^6.0|^7.0
- pestphp/pest: ^1.21
This package is auto-updated.
Last update: 2022-08-12 19:47:22 UTC
README
Laravel Larex: Crowdin Plugin
A Laravel Larex plugin to import/export localization strings from/to Crowdin
📋 Requirements
- PHP ≥ 8.0
- Laravel ≥ 8
- Laravel Larex ≥ v4.0
- Crowdin API Token v2
- Crowdin Project ID
Crowdin > Project > Settings > API & Webhooks > Project Id [API v2]
🚀 Installation
You can install the package using composer:
composer require lukasss93/laravel-larex-crowdin --dev
Then add the service provider to config/app.php
.
This step can be skipped if package auto-discovery is enabled.
'providers' => [ Lukasss93\LarexCrowdin\LarexCrowdinServiceProvider::class ];
⚙ Publishing the config file
Publishing the config file is optional:
php artisan vendor:publish --provider="Lukasss93\LarexCrowdin\LarexCrowdinServiceProvider" --tag="larex-crowdin-config"
🔧 Configuration
- Install Laravel Larex ≥ v3.5
- Publish (if you haven't already) and edit your larex.php config
- Append the Crowdin importer in the
importers.list
array://... 'importers' => [ //... 'list' => [ //... 'crowdin' => Lukasss93\LarexCrowdin\Importers\CrowdinImporter::class, ], ], //...
- Append the Crowdin exporter in the
exporters.list
array://... 'exporters' => [ //... 'list' => [ //... 'crowdin' => Lukasss93\LarexCrowdin\Exporters\CrowdinExporter::class, ], ], //...
- Edit your .env file and append the following strings:
# You can generate your token here: https://crowdin.com/settings#api-key # Please note: this library supports only the Crowdin API v2 LAREX_CROWDIN_TOKEN=<crowdin-token> # You can get your project id (API v2) here: # https://crowdin.com/project/your-project/settings#api LAREX_CROWDIN_PROJECT_ID=<crowdin-projectID>
👓 Usage
- Run
php artisan larex:import crowdin
to import strings from your Crowdin Project into your Larex CSV - Run
php artisan larex:export crowdin
to export strings from your Larex CSV into your Crowdin Project - You can still use the
--include
and--exclude
options to select specific languages to import/export
⚗️ Testing
composer test
🔰 Version Support
Larex Crowdin | L7.x | L8.x | L9.x |
---|---|---|---|
^1.0 | ✅ | ✅ | ❌ |
^2.0 | ❌ | ✅ | ✅ |
Larex Crowdin | PHP7.4 | PHP8.0 | PHP8.1 |
---|---|---|---|
^1.0 | ✅ | ✅ | ✅ |
^2.0 | ❌ | ✅ | ✅ |
📃 Changelog
Please see the CHANGELOG.md for more information on what has changed recently.
🏅 Credits
📖 License
Please see the LICENSE.md file for more information.