Skip to content
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

Composer-ing components #210

Closed
wants to merge 4 commits into from
Closed
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
64 changes: 33 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,62 @@
FluxCP
======
# FluxCP

Flux Control Panel (FluxCP) for rAthena servers.

Requirements
---------
* PHP 5.2
Table of Contents
1. [Requirements](#requirements)
2. [What's New](#whats-new)
3. [How To](#how-to)
4. [Join the Discussion](#join-the-discussion)
5. [Extra Credits](#extra-credits)

## Requirements
* PHP 5.4
* PDO and PDO-MYSQL extensions for PHP5 (including PHP_MYSQL support)
* MySQL 5
* Optional: GD2 (for guild emblems and registration CAPTCHA)
* Optional: Tidy (for cleaner HTML output)
* Optional: mod_rewrite support for UseCleanUrls feature
* Optional: [Item images](http://rathena.org/board/files/file/2509-item-images/)
* Composer


What's New?
---------
## What's New?
* The description files are kept upto-date with each new commit from rAthena.
* Pre-integrated themes:
- default
- Bootstrap
* default
* Bootstrap

* Built-In:
- News and Pages CMS with integrated TinyMCE
- Service Desk (ITIL Incident Management style support ticket system)
- Additional Logs
- More Ranking Lists
- Discord Integration
- Google ReCaptcha
- Remote AtCommand functionality
* News and Pages CMS with integrated TinyMCE
* Service Desk (ITIL Incident Management style support ticket system)
* Additional Logs
* More Ranking Lists
* Discord Integration
* Google ReCaptcha
* Remote AtCommand functionality


How To ... ?
---------
## How To
We have a small doc library that covers:
* Basic User Documentation
- Installation
- [Themes](https://github.com/rathena/FluxCP/blob/master/doc/user_theme.md)
- [Languages](https://github.com/rathena/FluxCP/blob/master/doc/user_lang.md)
- Installing Addons
- Updating FluxCP
* [Installation](https://github.com/rathena/FluxCP/blob/master/doc/installing.md)
* [Themes](https://github.com/rathena/FluxCP/blob/master/doc/user_theme.md)
* [Languages](https://github.com/rathena/FluxCP/blob/master/doc/user_lang.md)
* Installing Addons
* Updating FluxCP

* Developer Documentation
- Creating an Addon
- Providing Addon updates
- Creating a custom Theme
* Creating an Addon
* Providing Addon updates
* Creating a custom Theme


Join the Discussion
---------
## Join the Discussion
We have a discord server separate from rAthena just for FluxCP stuff!
The channels there can be used to obtain help, discuss testing, view anonymous feedback log, Github commits, etc.
https://discord.gg/JT3mD3t


Extra Credits
---------
## Extra Credits
Original FluxCP created by Paradox924X and Byteflux with additional contributions from Xantara.
Some works from other users have been integrated into this project.
16 changes: 16 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "rathena/fluxcp",
"type": "project",
"description": "rAthena FluxCP for PHP >= 5.4",
"keywords": [],
"homepage": "https://rathena.org/board/",
"license": "GPL-3.0-only",
"support": {
"forum": "https://rathena.org/board/"
},
"require": {
"php": ">=5.4",
"respect/validation": "^1.1.19",
"phpmailer/phpmailer": "^5.2.26"
}
}
219 changes: 219 additions & 0 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

31 changes: 31 additions & 0 deletions doc/installing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Installing rAthena FluxCP

Table of Contents

1. [Requirements](#requirements)
2. [Download FluxCP](#download-fluxcp)
3. [Installing Components](#installing-components)
4. [Configuration](#configuration)

## Requirements
Make sure all these requirements are met, read again in [Requirements](https://github.com/rathena/FluxCP/blob/master/README.md#requirements)

## Download FluxCP
Either you can download the zip version from this link https://github.com/rathena/FluxCP/archive/master.zip or by using git command
```
git clone https://github.com/rathena/FluxCP.git --branch master --single-branch
```

## Installing Components
FluxCP is running by external components that are not managed by FluxCP which provided in packagist. The components that FluxCP needed are:
1. PHPMailer 5.2.x for sending e-mail. (PHP > 5.0)
2. Respect/Validation 1.1.x for input validation. (PHP > 5.4)

After [downloading](#download-fluxcp) FluxCP, run this command in FluxCP's root directory
```
composer install
```

## Configuration

TODO
1 change: 1 addition & 0 deletions index.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
define('FLUX_THEME_DIR', 'themes');
define('FLUX_ADDON_DIR', 'addons');
define('FLUX_LANG_DIR', 'lang');
define('FLUX_VENDOR_AUTOLOAD', __DIR__ . '/vendor/autoload.php');

// Clean GPC arrays in the event magic_quotes_gpc is enabled.
if (ini_get('magic_quotes_gpc')) {
Expand Down
2 changes: 1 addition & 1 deletion lib/Flux/Mailer.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?php
require 'phpmailer/PHPMailerAutoload.php';
require_once FLUX_VENDOR_AUTOLOAD;
require_once 'Flux/LogFile.php';

class Flux_Mailer {
Expand Down
Loading