@Jim Parry Jim Parry authored on 1 Dec 2018
application Release 4.0.0-alpha.3 5 years ago
public Release 4.0.0-alpha.3 5 years ago
system Release 4.0.0-alpha.3 5 years ago
writable Release 4.0.0-alpha.3 5 years ago
.gitignore Initial commit 6 years ago
LICENSE Initial commit 6 years ago
README.md Release 4.0.0-alpha.3 5 years ago
composer.json Release 4.0.0-alpha.3 5 years ago
contributing.md Release 4.0.0-alpha.3 5 years ago
env Release 4.0.0-alpha.3 5 years ago
license.txt Release 4.0.0-alpha.3 5 years ago
phpunit.xml.dist Release 4.0.0-alpha.3 5 years ago
spark Release 4.0.0-alpha.3 5 years ago
README.md

CodeIgniter 4 Framework

What is CodeIgniter?

CodeIgniter is a PHP full-stack web framework that is light, fast, flexible, and secure. More information can be found at the official site.

This repository holds the distributable version of the framework, including the user guide. It has been built from the development repository.

This is pre-release code and should not be used in production sites.

More information about the plans for version 4 can be found in the announcement on the forums.

The user guide corresponding to this version of the framework can be found here.

Important Change with index.php

index.php is no longer in the root of the project! It has been moved inside the public folder, for better security and separation of components.

This means that you should configure your web server to "point" to your project's public folder, and not to the project root. A better practice would be to configure a virtual host to point there. A poor practice would be to point your web server to the project root and expect to enter public/..., as the rest of your logic and the framework are exposed.

Please read the user guide for a better explanation of how CI4 works! The user guide updating and deployment is a bit awkward at the moment, but we are working on it!

Repository Management

We use Github issues to track BUGS and to track approved DEVELOPMENT work packages. We use our forum to provide SUPPORT and to discuss FEATURE REQUESTS.

If you raise an issue here that pertains to support or a feature request, it will be closed! If you are not sure if you have found a bug, raise a thread on the forum first - someone else may have encountered the same thing.

Before raising a new Github issue, please check that your bug hasn't already been reported or fixed.

We use pull requests (PRs) for CONTRIBUTIONS to the repository. We are looking for contributions that address one of the reported bugs or approved work packages.

Do not use a PR as a form of feature request. Unsolicited contributions will only be considered if they fit nicely into the framework roadmap. Remember that some components that were part of CodeIgniter 3 are being moved to optional packages, with their own repository.

Contributing

We welcome contributions from the community.

Please read the Contributing to CodeIgniter section in the development repository.

Server Requirements

PHP version 7.1 or higher is required, with the following extensions installed:

  • intl
  • libcurl if you plan to use the HTTP\CURLRequest library

Additionally, make sure that the following extensions are enabled in your PHP:

  • json (enabled by default - don't turn it off)
  • mbstring
  • mysqlnd
  • xml (enabled by default - don't turn it off)