<commit_before>cSphere
=======

Generic PHP Web-CMS with low footprint and high extensibility

The current version is available under the terms of the 'Simplified BSD License'

Website: http://www.csphere.eu

Travis CI: [![Build Status](https://travis-ci.org/csphere-cms/csphere.png?branch=dev)](https://travis-ci.org/csphere-cms/csphere)

Table of contents
=================
1. Features
2. Requirements
3. Installation
4. Documentation

Features
========

This Web-CMS can be used for nearly every use case from a blog to a large community driven website with a forum and additional services. It is mainly optimized for fast creation and long-time maintenance of highly dynamic content. Thanks to advanced caching techniques it is able to scale up alot. It includes e.g.:

- Complete multi language support with English and German shipped already
- Modern and slim HTML5 interface using jQuery, Bootstrap and FontAwesome
- Plugins to easily add more functionality
- Themes to change the design and even override the design of all plugins
- Flawless underlying framework with high quality and zero external requirements
- Powerful debug and error functionality for developers
- Fast development of new plugins with rapid application development tools
- Full AJAX support for title, content and every sub-content (called box) 
- All you need to start: users, groups, a blog with tags and a contact form

We have over 10 years experience in providing OpenSource Web-CMS with PHP. This project started back in 2003 as a CMS for esport related pages and is now reduced to only contain the lowest possible feature set every website needs.

If you (mainly) need the following functionality you might NOT want to use cSphere:

- cSphere does NOT and won't ever provide any console tools to tamper with
- cSphere does NOT provide anything to assist with the creation of rich web APIs
- cSphere does NOT support any kind of PHP annotations or alike magic behavior
- cSphere does NOT use advanced autoloading techniques, we use namespaces instead

Requirements
============

PHP 5.4.0 or newer on any webserver (PHP builtin webserver works, too)

The following PHP extensions must be available:

- date, fileinfo, filter, json, mcrypt, pcre, session, xml

One of the following database servers (with PDO extension in PHP):

- Microsoft SQL Server 2012+ / Microsoft LocalDB 2012+ (pdo_sqlsrv)
- MySQL 5.5+ / MariaDB 5.5+ (pdo_mysql)
- PostgreSQL 9.0+ (pdo_pgsql)
- SQLite 3.0+ (pdo_sqlite)

Legend: + means that the given version or any newer one will work

Installation
============

1. Download a release version or clone the GIT repository

2. Upload the whole csphere directory and index.php

3. Look into the webserver directory to grab the corresponding settings file

4. Change that file to match your environment and upload it to where index.php is located

5. Grant the csphere/config directory write access so that install can create a config file

6. Grant the csphere/storage directory and all subdirectories write access on filesystem

7. Do the following when running it on your own server:

- Start your webserver, e.g. the PHP builtin webserver in tools/server directory

- Start your database server when not using SQLite, since SQLite is already builtin in PHP

Now open your website and follow the installation instructions

Documentation
=============

For further information look into the docs directory or visit our website

The API documentation can be generated inside the tools/documentor directory<commit_msg>added quality score to readme<commit_after>cSphere
=======

Generic PHP Web-CMS with low footprint and high extensibility

The current version is available under the terms of the 'Simplified BSD License'

Website: http://www.csphere.eu

[![Build Status](https://travis-ci.org/csphere-cms/csphere.png?branch=dev)](https://travis-ci.org/csphere-cms/csphere)

[![Quality Score](https://scrutinizer-ci.com/g/csphere-cms/csphere/badges/quality-score.png?s=8d1d858ac3fffceb2cfb030c67d64c0380c4e44c)](https://scrutinizer-ci.com/g/csphere-cms/csphere/)


Table of contents
=================
1. Features
2. Requirements
3. Installation
4. Documentation


Features
========

This Web-CMS can be used for nearly every use case from a blog to a large community driven website with a forum and additional services. It is mainly optimized for fast creation and long-time maintenance of highly dynamic content. Thanks to advanced caching techniques it is able to scale up alot. It includes e.g.:

- Complete multi language support with English and German shipped already
- Modern and slim HTML5 interface using jQuery, Bootstrap and FontAwesome
- Plugins to easily add more functionality
- Themes to change the design and even override the design of all plugins
- Flawless underlying framework with high quality and zero external requirements
- Powerful debug and error functionality for developers
- Fast development of new plugins with rapid application development tools
- Full AJAX support for title, content and every sub-content (called box) 
- All you need to start: users, groups, a blog with tags and a contact form

We have over 10 years experience in providing OpenSource Web-CMS with PHP. This project started back in 2003 as a CMS for esport related pages and is now reduced to only contain the lowest possible feature set every website needs.

If you (mainly) need the following functionality you might NOT want to use cSphere:

- cSphere does NOT and won't ever provide any console tools to tamper with
- cSphere does NOT provide anything to assist with the creation of rich web APIs
- cSphere does NOT support any kind of PHP annotations or alike magic behavior
- cSphere does NOT use advanced autoloading techniques, we use namespaces instead


Requirements
============

PHP 5.4.0 or newer on any webserver (PHP builtin webserver works, too)

The following PHP extensions must be available:

- date, fileinfo, filter, json, mcrypt, pcre, session, xml

One of the following database servers (with PDO extension in PHP):

- Microsoft SQL Server 2012+ / Microsoft LocalDB 2012+ (pdo_sqlsrv)
- MySQL 5.5+ / MariaDB 5.5+ (pdo_mysql)
- PostgreSQL 9.0+ (pdo_pgsql)
- SQLite 3.0+ (pdo_sqlite)

Legend: + means that the given version or any newer one will work


Installation
============

1. Download a release version or clone the GIT repository

2. Upload the whole csphere directory and index.php

3. Look into the webserver directory to grab the corresponding settings file

4. Change that file to match your environment and upload it to where index.php is located

5. Grant the csphere/config directory write access so that install can create a config file

6. Grant the csphere/storage directory and all subdirectories write access on filesystem

7. Do the following when running it on your own server:

- Start your webserver, e.g. the PHP builtin webserver in tools/server directory

- Start your database server when not using SQLite, since SQLite is already builtin in PHP

Now open your website and follow the installation instructions


Documentation
=============

For further information look into the docs directory or visit our website

The API documentation can be generated inside the tools/documentor directory
{'fraction_non_alphanumeric': 0.06359497861774038, 'fraction_numerical': 0.013105255897365154, 'mean_word_length': 4.492424242424242, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '697937', 'n_tokens_mistral': 1934, 'n_tokens_neox': 1831, 'n_words': 1013}