/firevel

100% serverless Laravel Framework

Primary LanguagePHPMIT LicenseMIT

About Firevel

Firevel is a modified, serverless version of Laravel Framework designed to work inside Google App Engine PHP 7.3 standard environment, together with Google Firestore as database and cache.

In addition to standard Laravel Framework benefits it offers:

  • Simple, serverless setup.
  • Downscaling to zero.
  • Micro-service friendly design.
  • Free tier eligibility.
  • Capacity to deal with high loads.

Installation

  1. Create a project in the Google Cloud Platform Console.

  2. Install gcloud command-line tool.

  3. Create firevel project with:

composer create-project firevel/firevel
  1. Deploy project with:
gcloud app deploy

Firevel does not require any credentials while running inside App Engine. If you like to run it locally you will also need to set GOOGLE_CLOUD_PROJECT and GOOGLE_APPLICATION_CREDENTIALS .env variables. If you prefer to use git clone https://github.com/firevel/firevel.git, you should also run php artisan firevel:generate:app to generate your app.yaml file. You might also need to enable App Engine Admin API.

Differences between Laravel and Firevel.

Firevel is a Laravel 6 after small updates and packages installation:

Usage

You can use Firevel in the same way you use Laravel. Be aware of Firebase limits and Google App Engine limits.

You should also replace Eloquent models with Firequent, by using use Firevel\Firequent\Model; instead of use Illuminate\Database\Eloquent\Model; inside a model class. Keep in mind that Firequent is in beta and support only basic queries.

File Storage

By default Firevel running inside App Engine is using Google Cloud Storage file system, and {GOOGLE_CLOUD_PROJECT}.appspot.com/services/{GAE_SERVICE}/storage/ path.

CI

You can run a simple CI process with gcloud builds submit --config cloudbuild.yaml --substitutions _APP_KEY= with your production API key at the end. You can also connect it with your existing repository but remember about setting _APP_KEY in substitution variables.

You also must grant App Engine access to the Cloud Build service account.

More

Credits