recrud/recrud

CakePHP skeleton app

v2.1.3 2024-12-30 04:45 UTC

Requires

• php: >=8.1
• cakephp/authentication: ^3.0
• cakephp/cakephp: ^5.0.1
• cakephp/migrations: ^4.0.0
• cakephp/plugin-installer: ^2.0
• dereuromark/cakephp-tools: ^3.6
• dompdf/dompdf: ^3.0
• friendsofcake/cakepdf: ^5.0
• friendsofcake/cakephp-csvview: ^5.0
• friendsofcake/search: ^7.0
• josegonzalez/cakephp-upload: ^8.0
• lorenzo/audit-stash: ^4.1
• mobiledetect/mobiledetectlib: ^3.74

Requires (Dev)

• cakephp/bake: ^3.0.0
• cakephp/cakephp-codesniffer: ^5.0
• cakephp/debug_kit: ^5.0.0
• josegonzalez/dotenv: ^4.0
• phpunit/phpunit: ^10.1.0

Suggests

• cakephp/repl: Console tools for a REPL interface for CakePHP applications.
• 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.
• phpstan/phpstan: PHPStan focuses on finding errors in your code without actually running it. It catches whole classes of bugs even before you write tests for the code.

MIT

README

Re-CRUD 2.X enable the developer to create the fundamental web application functions, create, read, update and delete including the other features such as searching, reporting, audit trail and others. Re-CRUD is based on the CakePHP framework with integrated useful plugins.

🚀 Authors

• @Asyraf Wahi Anuar

License

MIT

Framework and Plugin Acknowledgements

• CakePHP
• Bootstrap
• jQuery
• Search Plugin
• Tools Plugin
• Upload Plugin
• CakePDF Plugin
• CSVview Plugin
• Authentication Plugin
• README Generator

Features

• CRUD with [Sneat] Bootstrap 5 template
• User management and profile
• Search / Filter
• QR Code for sharing
• Audit Trail
• FAQ
• To Do list / task
• Site Configuration
• Contact us
• Light/dark mode toggle [coming soon]
• ReCrudZero [coming soon]
• Archived [coming soon]
• Notification bar
• Promotion Ribbon
• Menu Management [coming soon]

Screenshots

Roadmap

• Additional records management features
• More details reporting pages
• Add more integrations

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Documentation

Documentation (Coming Soon)

Installation

Clone Re-CRUD repo

  composer create-project recrud/recrud

or

  git clone https://github.com/Asyraf-wa/recrud.git

Run composer update

  composer update

Configuration

Rename file app_local_example.php to app_local.php in config folder

Create database in phpmyadmin

Configure database

    'Datasources' => [
        'default' => [
            'host' => 'localhost',
            'port' => 'non_standard_port_number',
            'username' => 'root',
            'password' => '',
            'database' => 'recrud',
            'url' => env('DATABASE_URL', null),
        ],

Database migration

  bin/cake migrations migrate

Database seeding

  bin/cake migrations seed

Default account Info

  [e-mail] | 123456

🛠 Requirements

PHP 8+

intl extension

Table should contain attribute: status(int) 1 with default value 1. This is used to tag active records as active(1), disabled(0) and archived(2). It also will be used for reporting charts.

Set SQL Mode (Edit my.ini)

  sql-mode = ""

🔗 Webserver Links

Usage/Examples

Generate CRUD with ReCrud features:

bin/cake bake all tableName

Generate CRUD without ReCrud features:

bin/cake bake all tableName --theme ReCrudZero

Badges

Demo

Coming Soon