Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mus-inn/locale-laravel
Manage translations with Locale and smoothly synchronize them with your project using our simple package commands.
https://github.com/mus-inn/locale-laravel
laravel laravel-framework laravel-package localisation localization localization-tool
Last synced: about 2 months ago
JSON representation
Manage translations with Locale and smoothly synchronize them with your project using our simple package commands.
- Host: GitHub
- URL: https://github.com/mus-inn/locale-laravel
- Owner: mus-inn
- License: mit
- Created: 2022-02-14T16:48:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T19:05:46.000Z (6 months ago)
- Last Synced: 2024-10-22T09:57:28.605Z (2 months ago)
- Topics: laravel, laravel-framework, laravel-package, localisation, localization, localization-tool
- Language: PHP
- Homepage:
- Size: 49.8 KB
- Stars: 15
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# [Locale](https://uselocale.com): The Laravel localization tool
[](https://packagist.org/packages/uselocale/locale-laravel)
[](https://github.com/uselocale/locale-laravel/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/uselocale/locale-laravel/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/uselocale/locale-laravel)
[Locale](https://uselocale.com) is the first localization platform specifically built for Laravel. Forget the old-fashioned email exchanges between teams and translators that always slow down project development, manage translations with our admin panel and smoothly synchronize the files with your project using our simple package commands.
## Installation
Follow the details provided on [Locale](https://uselocale.com) after creating a new project.
## Available commands
### Setup
```bash
php artisan locale:setup
```
You only need to run this command once. It will upload your existing translations to Locale and prepare your local files to be synced in the future.
Your local files will be reformatted but won't change their content.
### Sync
```bash
php artisan locale:sync
```
Run this command to upload any new translation keys to Locale and download updates on all your target languages.
If there's any conflict during the process, you'll receive a confirmation message.
#### Forcing Sync to run
Syncing your translation will update your local files with new translations for Locale and upload new translations to Locale.
To keep you informed and in control with everything, you will be prompted for a confirmation before the command is executed. To
force the command to run without a prompt, use the `--force` flag:
```bash
php artisan locale:sync --force
```
#### Purge unused translations
By default, nothing is deleted from Locale. If you delete translation keys from your local code and sync, translations will
still be available from Locale. This is useful if you are working with multiple branches or some big new features.
However, sometimes you really need to delete old and unused translation keys from Locale. To do that, use the `--purge` flag:
```bash
php artisan locale:sync --purge
```
> **Warning**
> All keys that are not present in the current local branch will be permanently deleted.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Creagia](https://creagia.com)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.