as-shiddiq/cineex

CiNeex - CodeIgniter Next and Extendable

v0.0.2.3 2023-08-26 23:36 UTC

This package is auto-updated.

Last update: 2024-11-10 03:22:10 UTC


README

Cineex Logo

Cineex

What is this?

Cineex is a framework that uses codeigniter 4 as its base, which makes it easy to create projects with a module system.

What to use?

Cineex uses an additional base in its manufacture :

  1. CodeIgniter v4.5.1
  2. NeomorphismeUI as CSS Framework
  3. Dompdf for pdf creation purposes, can be replaced if needed
  4. UUID to create a uuid
  5. WEBP Convert for image to webp convertion.
  6. PHPMailer to send email

Why Should?

  1. Has a command line (RUN) that can be used to speed up the build up your project,
  2. Ready to be used for team projects because it uses the HMVC scheme.
  3. With a modular system so that modules can be used for other projects.
  4. Templates can be replaced and created for other project needs, except for the dashboard there is already a user interface.
  5. RestAPI ready! no need to create restapi manually, such as, create, read, update, delete, multidelete, nested arrays, even upload data
  6. Authentication ready!, Login, sign up, forgot password and profile features are already available so there is no need to create them again.

How to Use?

Installations

Installation is very easy, after create project with CodeIgniter then just use composer to install:

composer require as-shiddiq/cineex

next, copy file run as spark with command

cp vendor/as-shiddiq/cineex/run run
cp vendor/as-shiddiq/cineex/src/Default/app/Config/Paths.php app/Config/Paths.php

then run the command, to replace the default codeigniter file

php run replace:all

after that configure the .env file as desired, and then run

php run install

to install and run the project 😊

Codeigniter Not Installed Yet?

If you don't install CodeIgniter by default, you can do some additional configuration.

cp -r vendor/codeigniter4/framework/public public
cp -r vendor/codeigniter4/framework/app app
cp -r vendor/codeigniter4/framework/writable writable

then change path config on app\Config\Paths.php

public string $systemDirectory = __DIR__ . '/../../vendor/codeigniter4/framework/system';

After that, you can continue the process of replacing the default codeigniter coding with the cineex configuration.