docs(readme): revamp overview, quick start, and contribution links #9800
+69
−80
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,109 +1,98 @@ | ||
| # CodeIgniter 4 | ||
|
|
||
| [](https://packagist.org/packages/codeigniter4/framework) | ||
| [](https://github.com/codeigniter4/CodeIgniter4/actions/workflows/test-phpunit.yml) | ||
| [](https://github.com/codeigniter4/CodeIgniter4/actions/workflows/test-phpstan.yml) | ||
| [](LICENSE) | ||
|
|
||
| CodeIgniter 4 is a modern, lightweight PHP full-stack framework focused on developer productivity, speed, and security. It provides a collection of expressive libraries, a powerful CLI, and an intuitive MVC structure that helps you ship production-ready applications quickly. | ||
|
|
||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| - **Lightweight core** with optional packages so you only ship what you need. | ||
| - **Secure by design** thanks to CSRF protection, content security features, and built-in validation. | ||
| - **Developer friendly** CLI (`php spark`) for scaffolding, migrations, tasks, and testing. | ||
| - **Flexible architecture** that embraces PSR standards, Composer autoloading, and namespacing. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - PHP 8.1 or newer | ||
| - `ext-intl` and `ext-mbstring` enabled | ||
| - Recommended: `ext-curl`, `ext-json`, and database-specific extensions (`ext-mysqli`, `ext-pgsql`, etc.) | ||
|
|
||
| > PHP 8.1 reaches end of life on December 31, 2025. Upgrade sooner to stay supported. | ||
|
|
||
| ## Quick Start | ||
|
|
||
| 1. **Clone and install dependencies** | ||
| ```bash | ||
| git clone https://github.com/codeigniter4/CodeIgniter4.git | ||
| cd CodeIgniter4 | ||
| composer install | ||
| ``` | ||
|
Comment on lines
+29
to
+34
Member
There was a problem hiding this comment. This step is for contributors only to the framework development. As such, this is not the go to way of installing this. |
||
| 2. **Bootstrap your environment** | ||
| ```bash | ||
| cp env .env | ||
| php spark key:generate | ||
| ``` | ||
| On Windows use `copy env .env` instead of `cp`. | ||
| Update `.env` with your app name, base URL, and database credentials. | ||
| 3. **Serve the application** | ||
| ```bash | ||
| php spark serve | ||
| ``` | ||
| Visit `http://localhost:8080` to confirm the welcome page loads. | ||
|
|
||
| ## Common Tasks | ||
|
|
||
| - `php spark make:controller Home` – scaffold a controller. | ||
| - `php spark make:migration CreateUsers` – generate a database migration. | ||
| - `php spark migrate` – run pending migrations. | ||
| - `php spark routes` – inspect the current routing table. | ||
| - `php spark help` – list available CLI commands. | ||
|
|
||
| Composer scripts streamline maintenance tasks: | ||
|
|
||
| - `composer test` – run the PHPUnit suite. | ||
| - `composer analyze` – run static analysis (PHPStan + Rector dry run). | ||
| - `composer cs` – check coding standards. | ||
| - `composer cs-fix` – automatically fix coding standards. | ||
| - `composer metrics` – generate PhpMetrics reports. | ||
|
|
||
| ## Project Structure | ||
|
|
||
| - `app/` – application code (controllers, models, views, configuration). | ||
| - `public/` – web server document root containing `index.php`. | ||
| - `system/` – framework core (avoid editing directly). | ||
| - `tests/` – PHPUnit test suite. | ||
| - `writable/` – runtime storage (cache, logs, sessions, uploads). | ||
|
|
||
| Configure your web server (Apache/Nginx) to serve the `public/` directory to keep application files outside the public web root. | ||
|
|
||
| ## Documentation & Guides | ||
|
|
||
| - Official User Guide: https://codeigniter.com/user_guide/ | ||
| - In-progress Docs (latest develop): https://codeigniter4.github.io/CodeIgniter4/ | ||
| - API Reference: https://codeigniter4.github.io/api/ | ||
| - Community Forum: https://forum.codeigniter.com/ | ||
| - Slack Community: https://codeigniterchat.slack.com/ | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome bug reports, documentation updates, and pull requests from the community. Before contributing: | ||
|
|
||
| 1. Review the [contributing guide](contributing/README.md). | ||
| 2. Search existing issues to avoid duplicates. | ||
| 3. Use GitHub Issues for confirmed bugs and approved enhancements; use the forum for support or feature ideas. | ||
|
|
||
| PRs should include tests when applicable and follow the project's coding standards (`composer cs` / `composer cs-fix`). | ||
|
|
||
| ## Security | ||
|
|
||
| Report security issues via the [responsible disclosure process](SECURITY.md). Please do not open public GitHub issues for vulnerabilities. | ||
|
|
||
| ## License | ||
|
|
||
| CodeIgniter 4 is open-source software released under the [MIT License](LICENSE). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do you remove these badges?