README.md 2.86 KB
Newer Older
1
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/ACP3/cms/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/ACP3/cms/?branch=develop)
2
[![Code Climate](https://codeclimate.com/github/ACP3/cms/badges/gpa.svg)](https://codeclimate.com/github/ACP3/cms)
3
[![Coverage Status](https://coveralls.io/repos/github/ACP3/cms/badge.svg?branch=develop)](https://coveralls.io/github/ACP3/cms?branch=develop)
Tino Goratsch's avatar
Tino Goratsch committed
4
[![Build Status](https://travis-ci.org/ACP3/cms.svg)](https://travis-ci.org/ACP3/cms)
Tino Goratsch's avatar
Tino Goratsch committed
5
[![Dependency Status](https://www.versioneye.com/user/projects/57f64a469907da003a1a64d1/badge.svg?style=flat)](https://www.versioneye.com/user/projects/57f64a469907da003a1a64d1)
6
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/481/badge)](https://bestpractices.coreinfrastructure.org/projects/481)
7

Tino Goratsch's avatar
Tino Goratsch committed
8
# ACP3 CMS
9
The ACP3 CMS is a highly customizable and easy to use Web Content Management System based on PHP and MySQL. 
Tino Goratsch's avatar
Tino Goratsch committed
10 11 12

## Features

13 14
* Based on modular components
* Low barriers for disabled people
Tino Goratsch's avatar
Tino Goratsch committed
15 16 17 18
* Automatic generation of breadcrumbs to improve usability even further
* Secure: protection against SQL-injections, salted passwords, complete input validation...
* Wordlike text input with the WYSIWYG-Editors CKEditor and TinyMCE
* Easy to customize: Layout based on html templates, which can be styled with CSS
19
* Search engine optimized URIs
Tino Goratsch's avatar
Tino Goratsch committed
20 21 22
* Access Control Lists, which allow fine grained permissions 

If you want to find out more information about the features and the requirements, just go to the official [Project-Website](http://www.acp3-cms.net).
23 24 25 26 27

## Installation

To install the current development version directly from github, you have to do the following steps:

28
Clone the repository into a new directory:
29
```sh
30
$ git clone https://github.com/ACP3/cms.git <directory>
31 32
```

33 34 35 36
Make sure that you have composer already installed.

If so, execute the following command from the projects root directory:

37 38 39 40
```sh
$ composer install
```

41
Make sure that you have installed node.js with npm and gulp-cli globally.
42

43
If so, execute the following command from the projects root directory, to install the necessary frontend development dependencies:
44
```sh
45
$ npm install
46
```
47

48 49 50 51 52 53 54 55 56
##Contribute

Contributions to the ACP3 CMS are always welcome. Here is how you can contribute to ACP3:

- [Submit bugs](https://github.com/ACP3/cms/issues) and help us verify fixes
- [Submit pull requests](https://github.com/ACP3/cms/pulls) for bug fixes, features and discuss existing proposals

Please refer to our [Contribution guidelines](https://github.com/ACP3/cms/blob/master/CONTRIBUTING.md) for more details.

57 58 59
## Coding Style Guidelines
### PHP
We are using the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) Coding Style for all PHP files.
60 61 62 63

##License

This project is licensed under the terms of the [GPL 2.0+](https://github.com/ACP3/cms/blob/master/LICENCE).