chialab/bedita-app-template

A template for BEdita websites and apps.

v5.1.0 2023-07-11 07:44 UTC

Requires

• php: >=8.1
• ext-json: *
• bedita/api: ^5.0
• bedita/aws: ^3.0
• bedita/core: ^5.0
• bedita/i18n: ^4.0
• cakephp/cakephp: ^4.0
• cakephp/migrations: ^3.0.0
• cakephp/plugin-installer: ^1.3
• chialab/frontend-kit: ^3.3.0
• chialab/rna-cakephp: ^0.3.0
• mobiledetect/mobiledetectlib: 2.*

Requires (Dev)

• bedita/dev-tools: ^2.0
• cakephp/bake: ^2.0.0
• cakephp/cakephp-codesniffer: ^5.0
• cakephp/debug_kit: ^4.0.0
• josegonzalez/dotenv: 3.*
• phpstan/phpstan: ^1.5
• phpunit/phpunit: ^9
• psy/psysh: @stable

Suggests

• dereuromark/cakephp-ide-helper: After baking your code, this keeps your annotations in sync with the code evolving from there on for maximum IDE and PHPStan/Psalm compatibility.
• markstory/asset_compress: An asset compression plugin which provides file concatenation and a flexible filter system for preprocessing and minification.

MIT

README

A skeleton for creating applications with BEdita 5.x.

The framework source code can be found here: bedita/bedita.

Installation

1. Download Composer or update composer self-update.
2. Run composer create-project --prefer-dist chialab/bedita-app-template [app_name].

If Composer is installed globally, run

composer create-project --prefer-dist "chialab/bedita-app-template:^5.0"

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

composer create-project --prefer-dist "chialab/bedita-app-template:^5.0" 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 -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 config/app.php and setup the 'Datasources' and any other configuration relevant for your application.

Testing

Test database configuration is in app_local.php. You can override the database url using the DATABASE_TEST_URL environment variable:

export DATABASE_TEST_URL='mysql://root:****@localhost/bedita4_app'

Then, you can launch tests using the test composer command:

composer run test