https://github.com/cakephp/app

CakePHP application template
https://github.com/cakephp/app

cakephp cakephp-application php

Last synced: about 1 month ago
JSON representation

CakePHP application template

• Host: GitHub
• URL: https://github.com/cakephp/app
• Owner: cakephp
• Created: 2013-09-16T10:52:22.000Z (about 11 years ago)
• Default Branch: 5.x
• Last Pushed: 2024-11-01T13:03:53.000Z (about 1 month ago)
• Last Synced: 2024-11-01T14:18:13.043Z (about 1 month ago)
• Topics: cakephp, cakephp-application, php
• Language: PHP
• Homepage:
• Size: 3.24 MB
• Stars: 371
• Watchers: 57
• Forks: 392
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-cakephp - App template - An empty CakePHP project for use with composer. (Skeleton)

README

        
# CakePHP Application Skeleton

![Build Status](https://github.com/cakephp/app/actions/workflows/ci.yml/badge.svg?branch=5.x)

[![Total Downloads](https://img.shields.io/packagist/dt/cakephp/app.svg?style=flat-square)](https://packagist.org/packages/cakephp/app)

[![PHPStan](https://img.shields.io/badge/PHPStan-level%208-brightgreen.svg?style=flat-square)](https://github.com/phpstan/phpstan)

A skeleton for creating applications with [CakePHP](https://cakephp.org) 5.x.

The framework source code can be found here: [cakephp/cakephp](https://github.com/cakephp/cakephp).

## Installation

1. Download [Composer](https://getcomposer.org/doc/00-intro.md) or update `composer self-update`.

2. Run `php composer.phar create-project --prefer-dist cakephp/app [app_name]`.

If Composer is installed globally, run

```bash

composer create-project --prefer-dist cakephp/app

```

In case you want to use a custom app dir name (e.g. `/myapp/`):

```bash

composer create-project --prefer-dist cakephp/app myapp

```

You can now either use your machine's webserver to view the default home page, or start

up the built-in webserver with:

```bash

bin/cake server -p 8765

```

Then visit `http://localhost:8765` to see the welcome page.

## Update

Since this skeleton is a starting point for your application and various files

would have been modified as per your needs, there isn't a way to provide

automated upgrades, so you have to do any updates manually.

## Configuration

Read and edit the environment specific `config/app_local.php` and set up the

`'Datasources'` and any other configuration relevant for your application.

Other environment agnostic settings can be changed in `config/app.php`.

## Layout

The app skeleton uses [Milligram](https://milligram.io/) (v1.3) minimalist CSS

framework by default. You can, however, replace it with any other library or

custom styles.