mechastorm/laravel-lang-google-spreadsheet-importer

Laravel Artisan Command to generate Laravel Languages files from a Google Spreadsheet

Introduction

A Laravel (4.1 and above) package in an artisan command, which generates Laravel Languages files from a Google Spreadsheet., _(*1)

It will, _(*2)

• read data from a spreadsheet formatted like this
• outputs as Laravel Lang files like these

This library serves to simply interface with the Laravel framework. The bulk of the actual work is being done by key dependecies., _(*3)

Requirements

• Laravel >4.1
• PHP >5.4
• Composer Dependencies
  • Google Spreadsheet Exporter - This is where the bulk of the logic lies. So majority of the documenation on the format of the spreadsheet and how it is being parse can be found there
  • Google Spreadsheet API Client
  • The official Google Api Client
• A readable Google Spreadsheet
  • The Spreadsheet MUST be the new format (aka Google Sheets) to be compatible
  • Must be shared with the client email (further details on how to generate one below)

Background

The aim is to, _(*4)

• Avoid hard coding copy text
• Reduce the dev cycle required when doing edits to copy text
• Nicely handle multiple translations of a copy text

Further background can be found under the Google Spreadsheet Exporter. Especially read up on setting up your Google API client credentials., _(*5)

Todo

• Finalize codebase via usage on a Laravel Application
• Documentaion
  • How to setup Google API credentials
  • Usage
  • Contributing
• PhpUnit Tests

Installation

Installation is primary via composer., _(*6)

Create a composer.json file in your project and add the following:, _(*7)

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/asimlqt/php-google-spreadsheet-client"
        },
        {
            "type": "vcs",
            "url": "https://github.com/mechastorm/google-spreadsheet-exporter"
        }
    ],
    "require": {
        "mechastorm/laravel-lang-google-spreadsheet-importer": "1.*"
    }
}

1. Add to service provider

Once you have the package installed you'll need to add it to your providers in app/config/app.php, _(*8)

Example, _(*9)

'providers' => array(
    'Mechastorm\LaravelLangGoogleSpreadsheetImporter\LaravelLangGoogleSpreadsheetImporterServiceProvider',
),

Then confirm the artisan command exist by running php artisan list and check if there is a command for google-spreadsheet:generate-lang in the output., _(*10)

2. Publish Configuration and Configure

It's recommended that you publish the packages configuration., _(*11)

php artisan config:publish mechastorm/laravel-lang-google-spreadsheet-importer

You should open app/config/packages/mechastorm/laravel-lang-google-spreadsheet-importer/config.php and add in details on your spreadsheet and google api access. For details on what/how to add these configs, go to this main readme for more info especially on getting Google API credentials., _(*12)

It is strong recommended to do separate configurations per environment., _(*13)

Usage

Assuming you have already installed and configured it correctly, you can just run the artisan command to generate the language files, _(*14)

php artisan google-spreadsheet:generate-lang

or with enviroment, _(*15)

php artisan google-spreadsheet:generate-lang --env={env_name}

Tests

Coming Soon!, _(*16)

Contributors

• Shih Oon Liong (@mechastorm)

License

Released under the Apache 2.0 license., _(*17)