<commit_before>Kagura: A simple developer managed reporting framework

Kagura, allows you to build your own front end, and use SQL queries with a Freemarker based preprocessor, making it a
fast tool to deploy new code and make changes. It also uses a read only simple file based storage system, making it easy
to backup, deploy, and even to scale.

Kagura comprises of 2 components,
1. A REST backend that uses Karaf and Camel
2. A webserver front end, which the user is responsible for developing, an example one is provided with a usable Javascript library in the "example" directory.


How to start:
There are several ways of starting the example:
1. Run it all via Maven
2. Run the components in their appropriate containers
3. A mixed approach

Setup for any approach:
1. Compile the whole project, from the root directory run:
    mvn clean package install
Then start two shells; and each one change them to one of both the directories below:
Shell 1:
    cd example/javascript
Shell 2:
    cd services/

For the maven approach:
Shell 1:
    mvn clean package org.mortbay.jetty:jetty-maven-plugin:8.1.12.v20130726:run-exploded
Shell 2:
    cd kagura-camel
    mvn org.apache.camel:camel-maven-plugin:2.9.0:run

For running via their respective containers:
Shell 1:
    -TBA use maven approach
Shell 2:
    cd kagura-assembly/target
    tar xzf kagura-assembly-1.0-SNAPSHOT.tar.gz
    cd kagura-assembly-1.0-SNAPSHOT/bin
    ./karaf debug

I like what you have here and wish to deploy it and use it for our own means what do I do?
1. Copy one of the "TestReports" directories, modify the users.yaml and groups.yaml file as desired, then modify the reports as desired
2. Start the assembly project, then shut it down. This creates the com.base2.kagura.services.camel.cfg file in the kagura-assmebly-1.0-SNAPSHOT/etc/
3. Modify the created "com.base2.kagura.services.camel.cfg" file, put the full path the new directory
4. Start the container again
5. Test user
That's it. All further changes to files are live.<commit_msg>Tried to fix some of the readme.md formatting. Added white spaces and headers.<commit_after>Kagura: A simple developer managed reporting framework

Kagura, allows you to build your own front end, and use SQL queries with a Freemarker based preprocessor, making it a
fast tool to deploy new code and make changes. It also uses a read only simple file based storage system, making it easy
to backup, deploy, and even to scale.

Kagura comprises of 2 components,

1. A REST backend that uses Karaf and Camel

2. A webserver front end, which the user is responsible for developing, an example one is provided with a usable Javascript library in the "example" directory.


#How to start:

##There are several ways of starting the example:

1. Run it all via Maven

2. Run the components in their appropriate containers

3. A mixed approach

##Setup for any approach:

1. Compile the whole project, from the root directory run:

        mvn clean package install

    Then start two shells; and each one change them to one of both the directories below:

    Shell 1:

        cd example/javascript

    Shell 2:

        cd services/

##For the maven approach:
    Shell 1:

        mvn clean package org.mortbay.jetty:jetty-maven-plugin:8.1.12.v20130726:run-exploded

    Shell 2:

        cd kagura-camel
        mvn org.apache.camel:camel-maven-plugin:2.9.0:run

##For running via their respective containers:

    Shell 1:

        -TBA use maven approach

    Shell 2:

        cd kagura-assembly/target
        tar xzf kagura-assembly-1.0-SNAPSHOT.tar.gz
        cd kagura-assembly-1.0-SNAPSHOT/bin
        ./karaf debug

##Imaginary Questions

###I like what you have here and wish to deploy it and use it for our own means what do I do?

1. Copy one of the "TestReports" directories, modify the users.yaml and groups.yaml file as desired, then modify the reports as desired

2. Start the assembly project, then shut it down. This creates the com.base2.kagura.services.camel.cfg file in the kagura-assmebly-1.0-SNAPSHOT/etc/

3. Modify the created "com.base2.kagura.services.camel.cfg" file, put the full path the new directory

4. Start the container again

5. Test user

That's it. All further changes to files are live.
{'fraction_non_alphanumeric': 0.05764705882352941, 'fraction_numerical': 0.019294117647058823, 'mean_word_length': 3.470031545741325, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1286308', 'n_tokens_mistral': 1309, 'n_tokens_neox': 1237, 'n_words': 609}