Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jaredchu/slim3-gae-skeleton

Slim 3 skeleton working with Google App Engine include cron configuration.
https://github.com/jaredchu/slim3-gae-skeleton

cron gae google-app-engine php skeleton slim3

Last synced: about 1 month ago
JSON representation

Slim 3 skeleton working with Google App Engine include cron configuration.

Awesome Lists containing this project

README

        

# Slim3 GAE Skeleton
Slim 3 skeleton working with Google App Engine include cron configuration.

Demo [https://slim3-gae-skeleton.appspot.com/health_check](https://slim3-gae-skeleton.appspot.com/health_check).

[![Packagist](https://img.shields.io/packagist/v/jaredchu/slim3-gae-skeleton.svg)](https://packagist.org/packages/jaredchu/slim3-gae-skeleton)
[![Packagist](https://img.shields.io/packagist/dt/jaredchu/slim3-gae-skeleton.svg)](https://packagist.org/packages/jaredchu/slim3-gae-skeleton)
[![Packagist](https://img.shields.io/packagist/l/jaredchu/slim3-gae-skeleton.svg)](https://packagist.org/packages/jaredchu/slim3-gae-skeleton)

## Installation
`$ composer create-project --no-interaction --stability=dev jaredchu/slim3-gae-skeleton my-app`

## Deploy

Install [gcloud](https://cloud.google.com/sdk/downloads) then run init command in project directory:

`$ gcloud init`

Deploy your project:

`$ gcloud app deploy`

Browse to **http://[YOUR_PROJECT_ID].appspot.com**

Remember to run this command after update `cron.yaml`:

`$ gcloud app deploy cron.yaml`

## Run locally
1. `$ cd my-app`
2. `$ php -S 0.0.0.0:8888 -t . index.php`
3. Browse to http://localhost:8888

## Key directories
- `app`: application code
- `app/Controllers`: contains controller classes
- `app/Enums`: contains enum classes
- `app/Schedules`: contains schedule classes

## Key files
- `index.php`: Entry point to application, route configuration
- `app.yaml`: Google App Engine main configuration
- `cron.yaml`: Google App Engine cron configuration

## Contributing
1. Fork it!
2. Create your feature branch: `$ git checkout -b feature/your-new-feature`
3. Commit your changes: `$ git commit -am 'Add some feature'`
4. Push to the branch: `$ git push origin feature/your-new-feature`
5. Submit a pull request.

## License
[MIT License](https://github.com/jaredchu/Slim3-GAE-Skeleton/blob/master/LICENSE)