bedita/app

BEdita base WebApp

v2.3.1 2022-09-07 15:13 UTC

Requires

• php: >=7.4
• bedita/i18n: ^4.1.4
• bedita/web-tools: ^3.9.0
• cakephp/cakephp: ~4.4.1
• cakephp/plugin-installer: ^1.3
• mobiledetect/mobiledetectlib: ^2.8

Requires (Dev)

• cakephp/bake: ^2.7
• cakephp/cakephp-codesniffer: ~4.5.1
• cakephp/debug_kit: ^4.8.1
• cakephp/repl: ^0.1
• dereuromark/cakephp-ide-helper: ^1.17
• josegonzalez/dotenv: ^3.2
• phpstan/phpstan: ^1.7.1
• phpunit/phpunit: ^9.5

Suggests

• markstory/asset_compress: An asset compression plugin which provides file concatenation and a flexible filter system for preprocessing and minification.

LGPL-3.0-or-later

README

This is the BEdita skeleton web app.

Requirements

1. PHP 7.4, 8.0, 8.1 or 8.2
2. Download latest Composer or update via composer self-update.

Installation

Simply run

composer create-project bedita/app

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

composer create-project bedita/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:

bin/cake server

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

Configuration

Read and edit the environment specific in config/.env in particular:

• BEDITA_API and BEDITA_API_KEY to setup API endpoint
• DEBUG set to "true" or "false"to activate/deactivate debug mode

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

You may then check http://localhost:8765/credits or http://localhost:8765/{folder} where {folder} is a folder uname on you BEdita4 project.

Layout

The app skeleton uses Milligram (v1.3) minimalist CSS framework by default. You can, however, replace it with any other library or custom styles.

I18n

Internationalization behavior is not enabled by default.

To activate:

• in config/app.php uncomment I18n key and setup your wanted configuration
• in src/Application.php uncomment lines to add I18nMiddleware in ::middleware() method
• in config/routes.php ucomment lines with 'routeClass' => 'BEdita/I18n.I18nRoute' to enable routing rules

After that evey URL path will have a language prefix like /en automatically generated. Using I18nHelper methods you may then handle URLs or object properties accordingly.