bedita/api-template

BEdita5 API project template app

v2.2.1 2024-11-11 14:10 UTC

Requires

• php: >=8.2
• bedita/api: ^5.29
• bedita/aws: ^3.0.5
• bedita/core: ^5.29
• cakephp/cakephp: ^4.5.0
• cakephp/plugin-installer: ^1.3.1

Requires (Dev)

• bedita/dev-tools: ^2.1.4
• cakephp/bake: ^2.8
• cakephp/cakephp-codesniffer: ~4.7.0
• cakephp/debug_kit: ^4.9.3
• cakephp/repl: ^0.1
• dereuromark/cakephp-ide-helper: ^1.18
• josegonzalez/dotenv: ^3.2
• phpstan/phpstan: ^1.9.14
• phpunit/phpunit: ^9.5

MIT

README

This is the skeleton app to build BEdita5 API projects.

Requirements

1. PHP >= 8.2
2. Download latest Composer or update via composer self-update.

Installation

Simply run

composer create-project bedita/api-template

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

composer create-project bedita/api-template myapp

You can now either use your machine's webserver to view the default home page, or start up the built-in webserver with:

bin/cake server

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

Configuration

Review and edit accordingly every configuration item in config/app_local.php. Make sure at least Datasources points to the desired DB instance.

Namespace

You need to manually change the default MyApp namespace in order to use a custom one (recommended before any application logic is introduced).

Files referencing MyApp are:

• composer.json
• bin/cake.php
• config/app.php or override in config/app_local.php
• src/Console/installer.php
• src/Shell/ConsoleShell.php
• Application.php (and test/TestCase/ApplicationTest.php)
• webroot/index.php

Make sure to launch composer dump-autoload after this manual change in order to update autoloader data