roelofjan-elsinga/laravel-onesky

Use artisan commands to keep track of your onesky translations

4.0.0 2022-08-05 09:02 UTC

This package is auto-updated.

Last update: 2024-03-05 12:31:19 UTC


README

Build status StyleCI Status Code coverage Total Downloads Latest Stable Version License

Notes about this forked version

This is a fork of the package: agares/laravel-onesky, but since it seems inactive, I'm maintaining a version here. The namespaces are still the same, so the only thing you have to do to migrate to this package, is replacing the installation like so:

composer remove ageras/laravel-onesky \
    && composer require roelofjan-elsinga/laravel-onesky

Description

A seamless integration between Laravel and the Onesky API.

By using artisan commands you can easily push new phrases ready for translation and pull translated phrases ready for production.

Installation

Require this package using composer:

composer require roelofjan-elsinga/laravel-onesky

Which version to use?

  • 1.0.0 uses Laravel 5.8
  • 2.0.0 uses Laravel 6.0
  • 3.0.0 uses Laravel 7.0

Usage

Copy the package config to your local config with the publish command:

php artisan vendor:publish --provider="Ageras\LaravelOneSky\ServiceProvider"

Change the newly published onesky.php file so that it matches your project.

Next, add ONESKY_API_KEY and ONESKY_SECRET to your .env file.

When you are ready to translate your language files, use this simple artisan command to upload them to your OneSky account:

php artisan onesky:push

When your language files have been translated, use this command to download them directly into your project:

php artisan onesky:pull

If you only want certain languages to be pulled, you can use the --lang= flag:

php artisan onesky:pull --lang=en,da,no

If you have multiple projects, you can use the --project= flag to specify the id:

php artisan onesky:push --project=1337

Contributing

Bug Reports

All issues are welcome, to create a better product, but your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue.

Which Branch?

All bug fixes should be sent to the develop branch. Bug fixes should never be sent to the master

Security Vulnerabilities

If you discover a security vulnerability within Sherlock package, write an email to Ageras' development team.

Coding Style

Ageras' follows the PSR-2 coding standard and the PSR-4 autoloading standard.

StyleCI

StyleCI automatically fixes code style to match the standard.

License

Copyright (c) 2016: Ageras Aps and other contributors:

Permission is hereby granted, free of charge, to any person 
obtaining a copy of this software and associated documentation 
files (the "Software"), to deal in the Software without restriction, 
including without limitation the rights to use, copy, modify, merge,
 publish, distribute, sublicense, and/or sell copies of the Software, 
 and to permit persons to whom the Software is furnished to do so, 
 subject to the following conditions:

The above copyright notice and this permission notice shall be included 
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 
OTHER DEALINGS IN THE SOFTWARE.