{"id":24926445,"url":"https://github.com/oanhnn/slim-skeleton","last_synced_at":"2025-04-09T20:41:39.241Z","repository":{"id":57029732,"uuid":"61619692","full_name":"oanhnn/slim-skeleton","owner":"oanhnn","description":"Slim Framework skeleton application following MVC construction","archived":false,"fork":false,"pushed_at":"2023-05-25T03:29:04.000Z","size":123,"stargazers_count":18,"open_issues_count":1,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-23T22:37:25.323Z","etag":null,"topics":["gulp","monolog","phpcs","phpunit","psr","skeleton","slim-framework"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oanhnn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-06-21T09:16:19.000Z","updated_at":"2023-05-25T03:29:02.000Z","dependencies_parsed_at":"2024-11-21T08:45:34.797Z","dependency_job_id":"9cd9c729-fe88-4f55-be76-90db819ced47","html_url":"https://github.com/oanhnn/slim-skeleton","commit_stats":{"total_commits":9,"total_committers":1,"mean_commits":9.0,"dds":0.0,"last_synced_commit":"f0c9dc29ac23d451e47634bf8924bd28f87d7789"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oanhnn%2Fslim-skeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oanhnn%2Fslim-skeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oanhnn%2Fslim-skeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oanhnn%2Fslim-skeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oanhnn","download_url":"https://codeload.github.com/oanhnn/slim-skeleton/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248109856,"owners_count":21049384,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gulp","monolog","phpcs","phpunit","psr","skeleton","slim-framework"],"created_at":"2025-02-02T12:52:17.658Z","updated_at":"2025-04-09T20:41:39.214Z","avatar_url":"https://github.com/oanhnn.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Slim Skeleton\n===\n[![Build Status](https://travis-ci.org/oanhnn/slim-skeleton.svg?branch=3.x)](https://travis-ci.org/oanhnn/slim-skeleton)\n[![Latest Stable Version](https://poser.pugx.org/oanhnn/slim-skeleton/v/stable)](https://packagist.org/packages/oanhnn/slim-skeleton)\n[![Total Downloads](https://poser.pugx.org/oanhnn/slim-skeleton/downloads)](https://packagist.org/packages/oanhnn/slim-skeleton)\n[![License](https://poser.pugx.org/oanhnn/slim-skeleton/license)](https://packagist.org/packages/oanhnn/slim-skeleton)\n\n[![Join the chat at https://gitter.im/oanhnn/slim-skeleton](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/oanhnn/slim-skeleton?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nA skeleton for [Slim Framework v3][slim-fw] following MVC pattern.   \n\nMain features\n---\n- [x] Support logging follow [PSR-3][psr3] with [Monolog][monolog]\n- [x] Support template engines: PHP view, Twig (default PHP view)\n- [x] Support database accessing with [Doctrine DBAL][doc-dbal], [CakePHP Database][cake-db] (support MySql, Postgresql, SQLite, ...)\n- [x] Support middlewares: Basic \u0026 Digest Authentication\n- [x] Support providers, easy to integrate with `slim/http-cache`, `slim/csrf`, `slim/flash`\n- [x] Support making database test and integration test with [PHPUnit][phpunit]\n- [x] Support coding style check with [PHPCS][phpcs]\n- [x] Support auto deploy with [Deployer][deployer]\n- [x] Support using [Gulp][gulp] task to compile SASS, ES6, CoffeeScript, ...\n\n#### Directories structure\n```\npath/to/project\n|-- app\n|   |-- assets\n|   |-- config\n|   |-- lang\n|   `-- templates\n|-- public\n|-- src\n|-- tests\n|-- tmp\n|   |-- cache\n|   `-- logs\n`-- vendor\n```\n\nRequirements\n---\n\n* PHP 5.5+\n* [Composer][compoer]\n* [npm][npm] (If using gulp to build assets)\n\nUsage\n---\n\n#### Create project\nUsing `composer` to create new project:\n\n```shell\n$ composer create-project oanhnn/slim-skeleton path/to/project --prefer-dist\n```\n\n#### Run PHP built-in server\nRun a built-in server on 0.0.0.0:8888\n```shell\n$ php -S 0.0.0.0:8888 -t public public/index.php\n```\n\nOpen web browser with address http://localhost:8888\n\n#### Check coding style and test\n```shell\n$ ./vendor/bin/phpcs\n$ ./vendor/bin/phpunit\n```\n\n#### Build assets with gulp, npm\nYou can use Gulp to compile SASS, ES6, CoffeeScript, ...\n\n```shell\n$ npm install\n$ npm run-script build\n```\n\n#### Run a task with gulp\n```shell\n$ node_modules/.bin/gulp \u003ctask\u003e\n```\n\n#### Deploy project\nYou can use Deployer to deploy project.   \nCopy and edit server's information from `deploy.php.dist` file to `deploy.php` file.   \nAfter that, you can run:\n\n```shell\n$ composer require deployer/deployer:^3.3.0 --dev\n$ ./vendor/bin/dep \u003cstage\u003e\n```\n\nSee an example in [here][deploy-ex].\n\nChangelog\n---\nSee all change logs in [CHANGELOG.md](CHANGELOG.md)\n\nContributing\n---\nAll code contributions must go through a pull request and approved by\na core developer before being merged. This is to ensure proper review of all the code.\n\nFork the project, create a feature branch, and send a pull request.\n\nTo ensure a consistent code base, you should make sure the code follows the [PSR-2][psr2].\n\nIf you would like to help take a look at the [list of issues](issues).\n\nLicense\n---\nThis project is released under the MIT License.   \nCopyright © 2013-2016 Oanh Nguyen.   \nPlease see [License File](LICENSE.md) for more information.\n\n\n[psr2]:      https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md\n[psr3]:      https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md\n[composer]:  https://getcomposer.org\n[npm]:       https://docs.npmjs.com/getting-started/installing-node\n[monolog]:   https://github.com/Seldaek/monolog\n[doc-dbal]:  https://github.com/doctrine/dbal\n[cake-db]:   https://github.com/cakephp/database\n[phpunit]:   https://phpunit.de/\n[phpcs]:     https://github.com/squizlabs/PHP_CodeSniffer\n[deployer]:  https://deployer.org\n[deploy-ex]: https://github.com/oanhnn/deployer-example\n[slim-fw]:   http://slimframework.com/\n[gulp]:      http://gulpjs.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foanhnn%2Fslim-skeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foanhnn%2Fslim-skeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foanhnn%2Fslim-skeleton/lists"}