{"id":15412142,"url":"https://github.com/maymeow/cakephp-starter-kit","last_synced_at":"2025-08-03T19:31:30.728Z","repository":{"id":37525302,"uuid":"410521883","full_name":"MayMeow/cakephp-starter-kit","owner":"MayMeow","description":"🚀 This is CakePHP  starter kit to help you to create CakePHP applications. Updated version of cakephp/app","archived":false,"fork":false,"pushed_at":"2023-01-20T17:31:20.000Z","size":387,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-18T09:49:28.898Z","etag":null,"topics":["boilerplate","cakephp4","development-environment","hacktoberfest","php","starter-kit"],"latest_commit_sha":null,"homepage":"https://starter.maymeow.dev/","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/MayMeow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null},"funding":{"github":"maymeow","patreon":null,"open_collective":null,"ko_fi":"maymeow","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2021-09-26T10:36:07.000Z","updated_at":"2023-01-15T15:35:08.000Z","dependencies_parsed_at":"2023-02-12T04:03:04.941Z","dependency_job_id":null,"html_url":"https://github.com/MayMeow/cakephp-starter-kit","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MayMeow%2Fcakephp-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MayMeow%2Fcakephp-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MayMeow%2Fcakephp-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MayMeow%2Fcakephp-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MayMeow","download_url":"https://codeload.github.com/MayMeow/cakephp-starter-kit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228561542,"owners_count":17937171,"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":["boilerplate","cakephp4","development-environment","hacktoberfest","php","starter-kit"],"created_at":"2024-10-01T16:51:25.916Z","updated_at":"2024-12-07T04:40:54.226Z","avatar_url":"https://github.com/MayMeow.png","language":"PHP","funding_links":["https://github.com/sponsors/maymeow","https://ko-fi.com/maymeow"],"categories":[],"sub_categories":[],"readme":"# CakePHP Application starter kit\n\nStarter kit contains:\n\n- Docker (Linux) or Docker Desktop (Mac or Windows)\n- CakePHP 4.4.1 application skeleton\n- Bootstrap 5.0 based theme plugin [WIP]\n- Predefined Development docker environment (CkePHP, PostgreSQL, Redis)\n- Ready to production deployment docker configuration (CakePHP, NGiNX, PostgreSQL, Redis), you can also enable traefik as well.\n\n## Your dev environment\n\nServices contained for dev environment in `docker-compose.dev.yml`\n\n|Service|Ports|Description|\n|----|----|----|\n|Your App|8080|Your application|\n|Adminer|8081|Database management tool|\n|Postgres|5432 not exposed in production environment|Database server|\n|Redis|6379 not exposed in production environment|Cache server|\n|Minio| 9000 (Api), 9001 (Console)|S3 compatible storage server|\n\n## Installation\n\nThere are more different ways how to use this project as template for your new application. You can use script **recomended** to \ndownload template for you\n\n```bash\ncurl https://raw.githubusercontent.com/MayMeow/cakephp-starter-kit/main/create -o create-app\nchmod +x create-app\nsudo mv create-app /usr/local/bin/\n```\n\nthen you can use `create-app \u003cyour-app-name\u003e` to create your application.\n\n or You can clone this project\n\n```bash\ngit clone --depth=1 --branch=main https://github.com/MayMeow/cakephp-starter-kit.git app_name\ncd app_name\nrm -rf .git # then initialize new git repository with git init and set your remotes\n```\n\nor with composer\n\n```bash\ncomposer create-project --prefer-dist maymeow/cakephp-starter-kit:dev-main app_name\ncd app_name\n```\n\nor with Docker\n\n```bash\nmdkir app_name\ncd app_name\ndocker run --rm --volume $(pwd):/app ghcr.io/maymeow/php-ci-cd/php-ci-cd:8.0.2-cs-git sh -c \"composer create-project --prefer-dist maymeow/cakephp-starter-kit:dev-main /app\"\nsudo chown -R $USER:$GID .\n```\n\n## Configuration\n\nApplication will generate security key automaticlly with each install and with each build. This is OK for development but not for production. It is recomended to generate key manually as follows\n\n```bash\ndocker-compose -f docker-compose.dev.yml run --rm cake-app php bin/cake.php generate_security_key\n```\n\nWhen you have key copy it and update `.env.production` file and paste your key right behind `SECURITY_SALT=` without any quotes.\n\nNext update `DB_USER`, `DB_NAME`, `DB_PASSWORD`, `POSTGRES_PASSWORD`, `POSTGRES_USER` and db `POSTGRES_DB`. Other variables are preconfigured and if you dont change values in docker compose files you are good to go.\n\n### Enabling debug mode\n\nFor developmen you can enable debug mode by setting `DEBUG=true` in `.env.production` file. **It is strongly recomended to diasble debug mode for production environment**\n\n## Console\n\nTo access console use command as follows\n\n```bash\ndocker-compose -f docker-compose.dev.yml run --rm cake-app php bin/cake.php\n```\nWhen you need to acces redis console you can use following command:\n\nGetting all keys from redis cacge database\n```bash\ndocker exec -it cake_redis redis-cl\n\n# keys *\n```\n\n## Issues, new features\n\nIf you found an issue or you want to provide feedback or you have an idea for new features. Use [Issue tab](https://github.com/MayMeow/cakephp-starter-kit/issues) on github project page.\n\n## Support\n\nIn case you wan to support development you can use funding button in right panel of this project. Or if you want to help develop this project write me email (address you can find on my profile) and I create account for you on my GitLab instance.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaymeow%2Fcakephp-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaymeow%2Fcakephp-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaymeow%2Fcakephp-starter-kit/lists"}