Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mgatner/ci-website

CodeIgniter Website
https://github.com/mgatner/ci-website

Last synced: 3 months ago
JSON representation

CodeIgniter Website

Awesome Lists containing this project

README 

        
# CodeIgniter Website



[![](https://github.com/codeigniter4projects/website/workflows/PHPUnit/badge.svg)](https://github.com/codeigniter4projects/website/actions/workflows/phpunit.yml)

[![](https://github.com/codeigniter4projects/website/workflows/PHPStan/badge.svg)](https://github.com/codeigniter4projects/website/actions/workflows/phpstan.yml)

[![](https://github.com/codeigniter4projects/website/workflows/Deptrac/badge.svg)](https://github.com/codeigniter4projects/website/actions/workflows/deptrac.yml)

[![Coverage Status](https://coveralls.io/repos/github/codeigniter4projects/website/badge.svg?branch=develop)](https://coveralls.io/github/codeigniter4projects/website?branch=develop)



This is the official website for the CodeIgniter PHP framework. 



The website has been open-sourced in the interest of transparency.

We welcome issues and pull requests, to handle corrections.  

New blog posts will not be accepted without prior authorization.



## Implementation



The site has been built with CodeIgniter 4, and is meant to be an example

of "good" programming style, although definitely not

the only way to do things. 



Some of the programming design decisions reflected:



-   The `public` folder is the intended document root for the webapp.

-   The architecture adheres more to the "model-view-adapter" convention,

    where the view is unaware of the source of data and the model is unaware of

    how any data might be presented. The controllers are go-betweens.

-   A "master template" lets each controller focus 

    only with building its part of a webpage.

-   A base controller takes care of assembling finished pages, using the 

    master template.

-   Mock data for the recent news and most recently active threads, means

    that the website can be tested locally, without needing access to 

    the live forum database.

-   View fragments are used to style single "records" on their own,

    improving cohesion.



## Resources



-  [User Guide](https://codeigniter.com/user_guide/index.html)

-  [Community Forums](https://forum.codeigniter.com/)

-  [Community Slack Channel](https://codeigniterchat.slack.com)



## Server Requirements



PHP version 7.2 or higher is required, with the following extensions installed: 



- [intl](https://php.net/manual/en/intl.requirements.php)

- [libcurl](https://php.net/manual/en/curl.requirements.php) if you plan to use the `HTTP\CURLRequest` library



Additionally, make sure that the following extensions are enabled in your PHP:



- json (enabled by default - don't turn it off)

- [mbstring](https://php.net/manual/en/mbstring.installation.php)

- [mysqlnd](https://php.net/manual/en/mysqlnd.install.php)

- xml (enabled by default - don't turn it off)



## Installation



Use these steps to create a local installation for development and testing.



1. Clone the repo: `git clone https://github.com/codeigniter4projects/website`

2. Work in the repo directory: `cd website`

3. Make sure the **writable** folder is accessible: `chmod -R 777 writable`

4. Install dependencies: `composer install`

5. Create your **.env** file: `cp env .env`

6. Edit **.env** and set at least the following:

	* `CI_ENVIRONMENT = development`

	* `database.default.database = ../writable/database.db`

	* `database.default.DBDriver = SQLite3`



The website is intended to live on the same server as the forums, and uses the forum

database to pull in the most recent posts. When developing locally, this poses a challenge.

To make local development simpler, a migration and seed have been provided to setup a 

table with some mock data that can be used in place of having a local MyBB install.



1. Migrate the database: `php spark migrate -all`

2. Run the seeder: `php spark db:seed ForumSeeder`



At this point you should have a usable version of the current code! Try launching it locally:



1. From the repo directory start serving the website: `php spark serve`

2. In your web browser of choice navigate to the local URL: `http://localhost:8080`



> Note: The example commands above are for Linux-based systems. You may need to adjust for your operating system.