logicent/crudbase

Crudbase

dev-main 2022-12-01 19:39 UTC

Requires

• php: ^8.0
• aeon-php/calendar: ^1.0
• bizley/migration: ^4.1
• bizley/quill: ^3.3
• bower-asset/fomantic-ui: ^2.9.0
• imaginary/yii2-fomantic-ui: ~2
• knplabs/knp-snappy: ^1.2
• league/csv: ^9.7
• league/flysystem: ^1.0
• mikehaertl/phpwkhtmltopdf: ^2.2
• myclabs/php-enum: ^1.8
• npm-asset/alpinejs: ^3.10
• npm-asset/animate.css: ^4.1.1
• npm-asset/datatables.net: ^1.12.1
• npm-asset/datatables.net-dt: ^1.12.1
• npm-asset/datatables.net-se: ^1.12.1
• npm-asset/dirrty: ^1.0.0
• npm-asset/flatpickr: ^4.6.13
• npm-asset/highlight.js: ^11.5.1
• npm-asset/htmx.org: ^1.8.0
• npm-asset/picocss--pico: ^1.5
• npm-asset/quill: ^1.3
• npm-asset/quill-smart-break: ^0.2
• npm-asset/sortablejs: ^1.15.0
• npm-asset/svg-loaders: ^0.2.0
• npm-asset/sweetalert2: ^11.4.24
• npm-asset/tabler--icons: ^1.69
• phpoffice/phpspreadsheet: ^1.17
• practically/yii2-chartjs: ^1.1
• spatie/db-dumper: ^2.21
• thamtech/yii2-uuid: ^1.2
• thamtech/yii2-yaml: ^0.3.2
• vlucas/phpdotenv: ^5.3
• yidas/phpspreadsheet-helper: ^1.3
• yii2mod/yii2-enum: *
• yiisoft/yii2: ~2.0.14
• yiisoft/yii2-bootstrap: ~2.0.0
• yiisoft/yii2-imagine: ^2.3
• yiisoft/yii2-shell: ^2.0
• yiisoft/yii2-swiftmailer: ~2.0.0

Requires (Dev)

• codeception/specify: ~0.4.3
• codeception/verify: ~0.3.1
• kint-php/kint: ^4.1
• yiisoft/yii2-debug: ~2.0.0
• yiisoft/yii2-faker: ~2.0.0
• yiisoft/yii2-gii: ~2.0.0

BSD-3-Clause

• Appsoft

• database
• yii2

README

Note: This is a alpha version of the software. You are advised to proceed with caution!

Introduction

Overview

A free and open source database administration and development tool for developers, database admins and sysadmins.

Installation

Prerequisites

• Git
• Composer
• NPM

Option 1: via Composer

• Run composer create-project logicent/crudbase:dev-main && cd crudbase

Option 2: via CLI

• Run git clone [e-mail]:logicent/crudbase.git && cd crudbase
• Run composer install

Continue:

• Create a database and update your .env settings
• Run ./crudle serve -t web in local environment or use preferred web server in production

System Architecture

Context

Crudbase is a database management tool for easy development and maintenance of relational and non-relational databases built using a modified Yii2-crudle template. It features a fully-fledged and responsive admin UI.

Containers

• app (Admin)
• modules (Plugins)

Components

• Main module - for bootstrapping the web app
• Setup module - for managing plugins & users
• Admin module - for managing your DB objects
• Extension modules - for installed plugins

Technology Stack

Programming Languages and Frameworks

• PHP 8.0 using Yii2 and JavaScript using jQuery & Htmx 2
• Dockerized (todo later)

Databases Supported

• MySQL
• MariaDB
• SQLite
• PostgreSQL

Roadmap

Now:

• Create Database
• Drop Database
• Alter Database (Create Database [Rename Table..To..] Drop Database)
• Create Table
• Rename Table
• Truncate Table
• Drop Table
• Create View
• Drop View
• Add Column
• Rename Column
• Alter Column
• Drop Column
• Add Primary Key
• Drop Primary Key
• Add Foreign Key
• Drop Foreign Key
• Create Index
• Drop Index

Next:

Later:

Want to contribute? Thank you for considering to make a contribution to Crudbase. New contributors to improve the solution further or help provide support to issues are most welcome.

License Crudbase is released under the BSD-3-Clause.