CodeIgniter 3 Ultimate

The aim of this project is to get the best practices and setup for startup project using CI3. Combine the library creation, blogs and articles related to CodeIgniter 3.
Explore the docs »

View Demo (soon) · Report Bug · Request Feature

Table of Contents

• Features
• Getting Started
  • Prerequisites
  • Installing
  • Developing
  • Running tests
  • Installation
  • Building
  • Deploying
  • Release
• Support
• Built With
• Acknowledgements and Contributing
• License

Features

• Use Composer setup and proper format of package psr1
• Follow the GitHub community standard repository for open-source

Getting Started

Prerequisites

• Web browser (better using Chrome or Firefox)
• PHP 5.6 Upward (Apache Server like XAMPP/WAMPP/LAMPP)
• PHPUnit
• XDebug (Optional)
• SSH ready device (Secured connection and dev environment for restricted network setup or office)
• Editor or IDE (VSCode/Netbeans/Phpstorm)
• Docker Setup (Optional)
• Linux or macOS or Windows
• Bash for Windows (git bash should suffice)

Installing

Clone the project

Developing

(Back to top)

Running Tests

the first phpunit is to create the xdebug file for generating faster report

$ cd /path/to/codeigniter/
$ cd bin/
$ phpunit --dump-xdebug-filter ../../bin/xdebug-filter.php

Output example

$ phpunit --dump-xdebug-filter ../../bin/xdebug-filter.php
PHPUnit 7.5.18 by Sebastian Bergmann and contributors.

Wrote Xdebug filter script to ../../bin/xdebug-filter.php

$ phpunit --prepend bin/xdebug-filter.php  --verbose --testdox

Output example

PHPUnit 7.5.18 by Sebastian Bergmann and contributors.

Runtime:       PHP 7.3.3 with Xdebug 2.8.1
Configuration: C:\xampp\htdocs\codeigniter-iii-ultimate\phpunit.xml

Welcome_test
 ✔ Index [149.21 ms]
 ✔ Method 404 [105.63 ms]
 ✔ A p p p a t h [43.57 ms]

Time: 1.25 seconds, Memory: 12.00 MB

OK (3 tests, 3 assertions)

Generating code coverage report in Clover XML format ... done

Generating Crap4J report XML file ... done

Generating code coverage report in HTML format ... done

Generating code coverage report in PHP format ... done

(Back to top)

Building

(Back to top)

Deploying

(Back to top)

Release

We use SemVer for versioning. For the versions available, see the tags on this repository.

(Back to top)

Support

Or

Support this project and others by

Built With

• Maven - Dependency Management
• ROME - Used to generate RSS Feeds

(Back to top)

Links

• Roadmap of planned features can be found here. Suggestions are welcome

(Back to top)

Acknowledgements and Contributing

• Hat tip to anyone whose code was used
• etc See also the list of contributors who participated in this project.

We love contributions! Check out the Contribution guide for more information. Simplest and really helpful for the community would be contribution meta information to our supported libraries list.

1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. (Back to top)

License

Copyright (c) 2019-present "The code in this project is licensed under MIT." This project is licensed under the MIT - see the LICENSE.md file for details (Back to top)