recrud/recrud

ReCRUD Skeleton App

Installs: 299

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 2

Open Issues: 0

Language:CSS

Type:project

v1.0.8 2023-11-27 12:05 UTC

This package is auto-updated.

Last update: 2024-03-27 12:58:27 UTC


README

Logo

Re-CRUD 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

License

MIT

Framework and Plugin Acknowledgements

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

App Screenshot

App Screenshot

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

🛠 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.

🔗 Webserver Links

XAMPP WAMP MAMP

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

MIT License

Demo

Coming Soon