Skip to content

Add links to official packages. #6060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions user_guide_src/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,12 @@ Advanced Topics

license
changelogs/index

*****************
Official Packages
*****************

.. toctree::
:titlesonly:

libraries/official_packages
69 changes: 69 additions & 0 deletions user_guide_src/source/libraries/official_packages.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
#################
Official Packages
#################

The CodeIgniter framework cannot solve all of the problems that developers will encounter.
Many users have said they love how small and fast the framework is, so we don't want to
bloat the core framework. To bridge the gap we are releasing official packages to provide
additional functionality that not every site will need or want.

.. contents::
:local:
:depth: 2

******
Shield
******

`CodeIgniter Shield <https://github.com/codeigniter4/shield>`_ is an authentication
and authorization framework for CodeIgniter 4. It is designed to be secure, flexible,
and easily extendable to meet the needs of many different types of websites.
Among the many featues, it includes:

* Session-based authentication
* Personal access token authentication
* framework for after login/register "actions" (like Two Factor Authentication, etc)
* Role-Based Access Control with simple, flexible permissions.
* Per-user permission overrides,
* and more...

********
Settings
********

`CodeIgniter Settings <https://github.com/codeigniter4/settings>`_ is a wrapper around
the configuration files that allows any configuration setting to saved to the database,
while defaulting to the config files when not custom value has been stored. This allows
an application to ship with the default config values, but adapt as the project grows
or moves servers, without having to touch the code.


*****
Cache
*****

We provide a library with `PSR-6 and PSR-16 Cache Adapters <https://github.com/codeigniter4/cache>`_
for CodeIgniter 4. This is not required for use, since CodeIgniter 4 comes with a fully-
functional cache component. This module is only for integrating third-party packages
that rely on the PSR interface provisions.


******
DevKit
******

`CodeIgniter DevKit <https://github.com/codeigniter4/devkit>`_ provides all of the
development tools that CodeIgniter uses to help ensure quality code, including
our coding standard, static analysys tools and rules, unit testing, data generation,
file-system mocking, security advisories, and more. This can be used in any of
your personal projects or libraries to get you rapidly setup with 17 different tools.


***************
Coding Standard
***************

The `CodeIgniter Coding Standard <https://github.com/CodeIgniter/coding-standard>`_
holds the official coding standards of CodeIgniter based on PHP CS Fixer and powered by
Nexus CS Config. This can be used in your own projects to form the basis of a
consistent set of style rules that can be automatically applied to your code.