2015-08-26 23:16:28 -05:00
# CodeIgniter 4 Development
2015-10-27 21:58:12 -05:00
2020-10-03 23:02:13 +07:00
[](https://github.com/codeigniter4/CodeIgniter4/actions?query=workflow%3A%22PHPUnit%22)
2018-11-11 17:28:39 -08:00
[](https://coveralls.io/github/codeigniter4/CodeIgniter4?branch=develop)
2020-04-04 07:57:28 +07:00
[](https://packagist.org/packages/codeigniter4/framework)
2020-03-09 22:56:36 +05:30
[](https://packagist.org/packages/codeigniter4/framework)
[](https://packagist.org/packages/codeigniter4/framework)
2020-10-28 17:13:25 +08:00
[](https://github.com/codeigniter4/CodeIgniter4/blob/develop/LICENSE)
2020-03-09 22:56:36 +05:30
[](https://github.com/codeigniter4/CodeIgniter4/pulls)
2016-03-18 22:21:12 -05:00
< br >
2015-10-27 21:58:12 -05:00
2016-05-15 00:36:44 -05:00
## What is CodeIgniter?
2019-01-17 23:44:21 -08:00
2020-12-21 22:02:34 +07:00
CodeIgniter is a PHP full-stack web framework that is light, fast, flexible and secure.
2016-06-03 01:25:40 -07:00
More information can be found at the [official site ](http://codeigniter.com ).
2016-05-15 00:36:44 -05:00
2020-04-06 07:56:13 +07:00
This repository holds the source code for CodeIgniter 4 only.
Version 4 is a complete rewrite to bring the quality and the code into a more modern version,
while still keeping as many of the things intact that has made people love the framework over the years.
2016-05-15 00:36:44 -05:00
2015-08-26 23:16:28 -05:00
More information about the plans for version 4 can be found in [the announcement ](http://forum.codeigniter.com/thread-62615.html ) on the forums.
2017-04-26 09:17:56 -05:00
### Documentation
2020-04-06 07:56:13 +07:00
The [User Guide ](https://codeigniter4.github.io/userguide/ ) is the primary documentation for CodeIgniter 4.
2018-11-09 12:33:42 -08:00
2020-04-06 07:56:13 +07:00
The current **in-progress** User Guide can be found [here ](https://codeigniter4.github.io/CodeIgniter4/ ).
2019-04-03 23:47:05 -07:00
As with the rest of the framework, it is a work in progress, and will see changes over time to structure, explanations, etc.
You might also be interested in the [API documentation ](https://codeigniter4.github.io/api/ ) for the framework components.
2017-04-26 09:17:56 -05:00
2016-06-25 12:58:05 -07:00
## 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.
2016-06-25 12:59:42 -07:00
**Please** read the user guide for a better explanation of how CI4 works!
2016-06-03 01:25:40 -07:00
## Repository Management
2019-01-17 23:44:21 -08:00
2020-04-06 07:56:13 +07:00
CodeIgniter is developed completely on a volunteer basis. As such, please give up to 7 days
for your issues to be reviewed. If you haven't heard from one of the team in that time period,
feel free to leave a comment on the issue so that it gets brought back to our attention.
2020-02-16 22:02:05 -06:00
2021-10-14 02:11:05 +09:00
We use GitHub issues to track **BUGS** and to track approved **DEVELOPMENT** work packages.
2016-06-03 01:25:40 -07:00
We use our [forum ](http://forum.codeigniter.com ) 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.
2021-10-14 02:11:05 +09:00
Before raising a new GitHub issue, please check that your bug hasn't already
2020-04-06 07:56:13 +07:00
been reported or fixed.
2016-06-03 01:25:40 -07:00
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.
2015-08-26 23:16:28 -05:00
## Contributing
2019-01-17 23:44:21 -08:00
2019-05-17 11:11:14 -05:00
We **are** accepting contributions from the community!
2016-07-08 10:16:12 -07:00
2021-10-12 09:17:08 +09:00
Please read the [*Contributing to CodeIgniter* ](https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/README.md ).
2015-08-26 23:16:28 -05:00
## Server Requirements
2019-01-17 23:44:21 -08:00
2022-01-12 10:53:40 +09:00
PHP version 7.4 or higher is required, with the following extensions installed:
2016-11-05 23:22:44 -05:00
2018-10-15 06:57:56 +08:00
- [intl ](http://php.net/manual/en/intl.requirements.php )
- [libcurl ](http://php.net/manual/en/curl.requirements.php ) if you plan to use the HTTP\CURLRequest library
2020-04-06 07:56:13 +07:00
- [mbstring ](http://php.net/manual/en/mbstring.installation.php )
2016-11-05 23:22:44 -05:00
2018-10-15 06:57:56 +08:00
Additionally, make sure that the following extensions are enabled in your PHP:
- json (enabled by default - don't turn it off)
2019-05-16 11:21:35 -05:00
- xml (enabled by default - don't turn it off)
2018-10-15 06:57:56 +08:00
- [mysqlnd ](http://php.net/manual/en/mysqlnd.install.php )
2015-08-28 23:29:10 -05:00
2016-05-15 00:36:44 -05:00
## Running CodeIgniter Tests
2019-01-17 23:44:21 -08:00
2019-05-16 11:21:35 -05:00
Information on running the CodeIgniter test suite can be found in the [README.md ](tests/README.md ) file in the tests directory.
