avior/DeltaCMS
1
0
Fork 0
mirror of https://github.com/Aviortheking/DeltaCMS.git synced 2025-04-23 19:32:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Florian Bouillon 2019-04-25 22:54:29 +02:00
parent b80d605ba4
commit c4c806a3e0
1 changed files with 50 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -1,5 +1,7 @@
# Admin Panel
[![Logo (<3)](https://git.delta-wings.net/DeltaCMS/Ressources/raw/branch/master/open-graph.png)](https://delta-wings.net)
[![build](https://img.shields.io/drone/build/DeltaCMS/Core.svg?server=https%3A%2F%2Fci.delta-wings.net&style=for-the-badge)](https://ci.delta-wings.net/DeltaCMS/Core/)
![coverage](https://img.shields.io/codacy/coverage/bf7f9ac73707426e9afc4b9daa950039.svg?style=for-the-badge)
![Code Quality](https://img.shields.io/codacy/grade/bf7f9ac73707426e9afc4b9daa950039.svg?style=for-the-badge)
@ -9,8 +11,9 @@
- [Admin Panel](#admin-panel)
- [Table of Content](#table-of-content)
- [Description](#description)
- [What is Delta CMS ?](#what-is-delta-cms)
- [Install](#install)
- [Build](#build)
- [Build from source](#build-from-source)
- [Changelog](#changelog)
- [Badges](#badges)
- [Build status](#build-status)
@ -21,29 +24,36 @@
## Description
WIP
### What is Delta CMS ?
This is a Content Management System made to be simple for end users AND developpers with everything made into modules.
(more later)
## Install
Fetch the latest release from the release tab [here](https://git.delta-wings.net/DeltaCMS/Core/releases)
Fetch the latest release [here](https://git.delta-wings.net/DeltaCMS/Core/releases)
## Build
Please note that releases are **pre-built** for usage so you don't need to follow the [build](#build) step
run this command in the terminal
Now point your web server to the `public` folder and tada :smile: your website is up
## Build from source
Clone the project and run this command in the terminal.
```console
composer install --no-dev --optimize-autoload
```
Now point your web server to the `public` folder and tada =) your website is up
now follow the [install](#install) guide
## Changelog
see [changelog.md](./changelog.md)
See [changelog.md](./CHANGELOG.md)
## Badges
We're using [shields.io](https://shields.io/) badges
Badges are powered by [shields.io](https://shields.io/)
### Build status
@ -68,22 +78,45 @@ _([Codacy](https://app.codacy.com/project/Aviorleking/DeltaCMS/dashboard))_
## Dependencies
DeltaCMS is powered by all these awesome projects
- [Composer](https://getcomposer.org/)
- [PSR-3](https://www.php-fig.org/psr/psr-3), [PSR-6](https://www.php-fig.org/psr/psr-6)
- [PSR-3](https://www.php-fig.org/psr/psr-3), [PSR-16](https://www.php-fig.org/psr/psr-16)
- [Twig](https://twig.symfony.com/)
:heavy_plus_sign: DeltaCMS respect multiples [PSRs](https://www.php-fig.org/)
- [PSR-2](https://www.php-fig.org/psr/psr-2) (by extension [PSR-1](https://www.php-fig.org/psr/psr-1))
- (in-review [PSR-12](https://github.com/php-fig/fig-standards/blob/master/proposed/extended-coding-style-guide.md))
- [PSR-3](https://www.php-fig.org/psr/psr-3) `\DeltaCMS\Logger`
- [PSR-4](https://www.php-fig.org/psr/psr-4) (thanks to composer)
- [PSR-16](https://www.php-fig.org/psr/psr-16) get the cache with this `DeltaCMS::getInstance()->getCache()` or the shortcut given by the class
## Development Dependencies
- [EditorConfig](https://editorconfig.org/)
- Editor Synchronization
- [EditorConfig](https://editorconfig.org/)
- [Git](https://git-scm.com/)
- [Issue & Merge request templates](https://www.talater.com/open-source-templates/#/)
- [Composer](https://getcomposer.org/)
- [PHP Codesniffer](https://github.com/squizlabs/PHP_CodeSniffer)
- Dependency Management
- [Composer](https://getcomposer.org/)
- Debugging (like a pro :yum:)
- [Symfony VarDumper](https://symfony.com/doc/current/components/var_dumper.html)
- [PHPUnit](https://phpunit.de/)
- [PHP Mess Detector](https://phpmd.org/)
- Hosting
- [Gitlab](https://gitlab.com/) _Project url [here](https://gitlab.com/delta-wings/adminpanel)_
- [Gitea](https://gitea.io/) _Current server [here](https://git.delta-wings.net/Avior/DeltaCMS)_
- [Gitlab](https://gitlab.com/) mirror _Project url [here](https://gitlab.com/delta-wings/adminpanel)_
- [Gitea](https://gitea.io/) _Current server [here](https://git.delta-wings.net/DeltaCMS/Core)_
- [Drone](https://drone.io/) _Current server [here](https://ci.delta-wings.net/)_
- [Codacy](https://codacy.com/) _Project Dashboard [here](https://app.codacy.com/project/Aviorleking/DeltaCMS/dashboard)_
- Code Hosting
- [Gitea](https://gitea.io/) (Self-hosted) instance [here](https://git.delta-wings.net/DeltaCMS/Core)
- Mirrors
- [Gitlab](https://gitlab.com/) Project [here](https://gitlab.com/deltacms/core)
- [Github](https://github.com/) Project [here](https://github.com/deltacms/Core)
- Continuous integration
- [Drone](https://drone.io/) (Self-hosted) Instance [here](https://ci.delta-wings.net/DeltaCMS/Core/)
- Code Check (Testing, Code Analytics)
- [PHP Codesniffer](https://github.com/squizlabs/PHP_CodeSniffer)
- [PHPUnit](https://phpunit.de/)
- [PHP Mess Detector](https://phpmd.org/)
- Other
- [Issue & Merge request templates](https://www.talater.com/open-source-templates/#/)