https://github.com/CurlyBytes/codeigniter-iii-ultimate
All the best practice and setup for startup project using CI3
https://github.com/CurlyBytes/codeigniter-iii-ultimate
ajax azure azure-devops best-practices ci3 cicd codeigniter3 composer docker html-css-javascript oop php phpunit progressive-enhancement progressive-web-app startup template-project
Last synced: 4 months ago
JSON representation
All the best practice and setup for startup project using CI3
- Host: GitHub
- URL: https://github.com/CurlyBytes/codeigniter-iii-ultimate
- Owner: CurlyBytes
- License: mit
- Archived: true
- Created: 2019-09-21T07:22:57.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-17T08:59:41.000Z (over 5 years ago)
- Last Synced: 2024-07-29T17:04:53.381Z (11 months ago)
- Topics: ajax, azure, azure-devops, best-practices, ci3, cicd, codeigniter3, composer, docker, html-css-javascript, oop, php, phpunit, progressive-enhancement, progressive-web-app, startup, template-project
- Language: PHP
- Homepage:
- Size: 303 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
[](https://dev.azure.com/rafi-secdevops/Codeigniter%203%20Ultimate/_build/latest?definitionId=18&branchName=master)
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](#features)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installing](#installing)
* [Developing](#developing)
* [Running tests](#running-tests)
* [Installation](#installation)
* [Building](#building)
* [Deploying](#deploying)
* [Release](#release)
* [Support](#support)
* [Built With](#built-with)
* [Acknowledgements and Contributing](#acknowledgements-and-contributing)
* [License](#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
```git
Clone the project
```
### Developing
[(Back to top)](#table-of-contents)
### Running Tests
the first phpunit is to create the xdebug file for generating faster report
``` bash
$ 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
```
``` bash
$ 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)](#table-of-contents)
### Building
[(Back to top)](#table-of-contents)
### Deploying
[(Back to top)](#table-of-contents)
### Release
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
[(Back to top)](#table-of-contents)
## Support
Or
Support this project and others by
## Built With
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
[(Back to top)](#table-of-contents)
## Links
- **Roadmap** of planned features can be found [here](#). Suggestions are welcome
[(Back to top)](#table-of-contents)
## Acknowledgements and Contributing
* Hat tip to anyone whose code was used
* etc See also the list of [contributors](contributors.md) who participated in this project.
We love contributions! Check out the [Contribution guide](CONTRIBUTING.md) for more information. Simplest and really helpful for the community would be contribution meta information to our [supported libraries list](https://github.com/sourcerer-io/awesome-libraries).
1. Fork it ()
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](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
[(Back to top)](#table-of-contents)
## 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](LICENSE.md) file for details
[(Back to top)](#table-of-contents)
[psr4-link]: https://www.php-fig.org/psr/psr-4/ "PHP Standard Rule #4"