<commit_before>Oro Platform Empty Application
==============================
An example of empty application built using the Oro Platform.

This repository contains application configuration settings and depends on Oro Platform.

Important Note: this application is not production ready and is intended for evaluation and development only!

## Requirements

Oro Platform is Symfony 2 based application with following requirements:

* PHP 5.4.4 and above
* PHP 5.4.4 and above command line interface
* PHP Extensions
    * GD
    * Mcrypt
    * JSON
    * ctype
    * Tokenizer
    * SimpleXML
    * PCRE
    * ICU
* MySQL 5.1 and above

## Installation instructions

### Using Composer

[As both Symfony 2 and Oro Platform use [Composer][2] to manage their dependencies, this is the recommended way to install Oro Platform.]

If you don't have Composer yet, download it following the instructions on
http://getcomposer.org/ or just run the following command:

```bash
    curl -s https://getcomposer.org/installer | php
```

- Clone https://github.com/orocrm/platform-application.git Platform Application project with

```bash
    git clone https://github.com/orocrm/platform-application.git
```

- Make sure that you have installed NodeJS

- Go to app/config folder and create parameters.yml using parameters.yml.dist as example. Update database name and credentials
  Alternatively parameters.yml can be created automatically on the next step when run composer install command,
  you will be able to customize all the values interactively.
  
- Install Platform Application dependencies with composer. If installation process seems too slow you can use "--prefer-dist" option.

```bash
    php composer.phar install --prefer-dist
```

- Create the database (default name is "bap_standard")

- Open the BAP URL and initialize application with Install Wizard

- Alternatively with command line

```bash  
app/console oro:install
```
After installation you can login as application administrator using user name "admin" and password "<PASSWORD>".

## Installation notes

Installed PHP Accelerators must be compatible with Symfony and Doctrine (support DOCBLOCKs)

Using MySQL 5.6 with HDD is potentially risky because of performance issues

Recommended configuration for this case:

    innodb_file_per_table = 0

And ensure that timeout has default value

    wait_timeout = 28800

See [Optimizing InnoDB Disk I/O][3] for more


## Instant messaging between the browser and the web server

To use this feature you need to configure parameters.yml websocket parameters and run server with console command

 ```bash
app/console clank:server
```
Configure crontab or scheduled tasks execution to run command below every minute:

 ```bash
php app/console oro:cron
 ```

[1]:  http://symfony.com/doc/2.3/book/installation.html
[2]:  http://getcomposer.org/
[3]:  http://dev.mysql.com/doc/refman/5.6/en/optimizing-innodb-diskio.html<commit_msg>Updated installation steps in README.md<commit_after>Oro Platform Empty Application
==============================

An example of empty application built using the Oro Platform.

This repository contains application configuration settings and depends on Oro Platform. It can be used as a base for new application creation.

## Requirements

Oro Platform is Symfony 2 based application with following requirements:

* PHP 5.4.4 and above
* PHP 5.4.4 and above command line interface
* PHP Extensions
    * GD
    * Mcrypt
    * JSON
    * ctype
    * Tokenizer
    * SimpleXML
    * PCRE
    * ICU
* MySQL 5.1 and above

## Installation instructions

### Using Composer

As both Symfony 2 and Oro Platform use [Composer][2] to manage their dependencies, this is the recommended way to install Oro Platform.

If you don't have Composer yet, download it following the instructions on
http://getcomposer.org/ or just run the following command:

```bash
    curl -s https://getcomposer.org/installer | php
```

- Clone https://github.com/orocrm/platform-application.git Platform Application project with

```bash
    git clone https://github.com/orocrm/platform-application.git
```

- Make sure that you have [NodeJS][4] installed

- Install OroCRM dependencies with composer. If installation process seems too slow you can use "--prefer-dist" option.
  Go to crm-application folder and run composer installation:

```bash
php composer.phar install --prefer-dist
```

- Create the database with the name specified on previous step (default name is "bap_standard").

- Install application and admin user with Installation Wizard by opening install.php in the browser or from CLI:

```bash  
php app/console oro:install
```

- Enable instant messaging between the browser and the web server

```bash
php app/console clank:server --env prod
```

- Configure crontab or scheduled tasks execution to run command below every minute:

```bash
php app/console oro:cron
```
 
**Note:** ``app/console`` is a path from project root folder. Please make sure you are using full path for crontab configuration or if you running console command from other location.

## Installation notes

Installed PHP Accelerators must be compatible with Symfony and Doctrine (support DOCBLOCKs)

Using MySQL 5.6 with HDD is potentially risky because of performance issues

Recommended configuration for this case:

    innodb_file_per_table = 0

And ensure that timeout has default value

    wait_timeout = 28800

See [Optimizing InnoDB Disk I/O][3] for more


[1]:  http://symfony.com/doc/2.3/book/installation.html
[2]:  http://getcomposer.org/
[3]:  http://dev.mysql.com/doc/refman/5.6/en/optimizing-innodb-diskio.html
{'fraction_non_alphanumeric': 0.08405900124400213, 'fraction_numerical': 0.009774302470232806, 'mean_word_length': 4.1210191082802545, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, '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': '2288979', 'n_tokens_mistral': 1596, 'n_tokens_neox': 1490, 'n_words': 668}