<commit_before>![SPHERE.IO icon](https://admin.sphere.io/assets/images/sphere_logo_rgb_long.png)

sphere-sunrise
==============

[![Build Status](https://travis-ci.org/sphereio/sphere-sunrise.png?branch=master)](https://travis-ci.org/sphereio/sphere-sunrise)

The next generation shop template. Currently under initial development.

* Demo: https://sunrise.sphere.io

## Preconditions

* install [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
* install [SBT](http://www.scala-sbt.org/release/tutorial/Setup.html), Mac/Linux users can use the SBT script in the base folder (use `./sbt` instead of `sbt` in commands)

## Run it locally

* Setup your environment variables, so you need not to put your shop credentials under version control:

```bash
export SPHERE_SUNRISE_PROJECT="your-project-key"
export SPHERE_SUNRISE_CLIENT_SECRET="your-the-client-secret"
export SPHERE_SUNRISE_CLIENT_ID="your-client-id"
```

* You can store the variables in `~/.bash_profile` (Mac) or `~/.bashrc` (Linux) so the next time you open a console they are automatically available.
* `sbt ~run`

The output will be like

```
[info] play - Listening for HTTP on /0:0:0:0:0:0:0:0:9000

(Server started, use Ctrl+D to stop and go back to the console...)
```
<commit_msg>Update docu, add link to Javadoc and test coverage<commit_after>![SPHERE.IO icon](https://admin.sphere.io/assets/images/sphere_logo_rgb_long.png)

sphere-sunrise
==============

[![Build Status](https://travis-ci.org/sphereio/sphere-sunrise.png?branch=master)](https://travis-ci.org/sphereio/sphere-sunrise)

The next generation shop template. Currently under initial development.

* Demo: https://sunrise.sphere.io
* [Javadoc](https://sphereio.github.io/sphere-sunrise/javadoc/index.html)
* [Test Coverage Report](https://sphereio.github.io/sphere-sunrise/coverage/index.html)

## Preconditions

* install [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
* install [SBT](http://www.scala-sbt.org/release/tutorial/Setup.html), Mac/Linux users can use the SBT script in the base folder (use `./sbt` instead of `sbt` in commands)

## Run it locally

* Setup your environment variables, so you need not to put your shop credentials under version control:

```bash
export SPHERE_SUNRISE_PROJECT="your-project-key"
export SPHERE_SUNRISE_CLIENT_SECRET="your-the-client-secret"
export SPHERE_SUNRISE_CLIENT_ID="your-client-id"
```

* You can store the variables in `~/.bash_profile` (Mac) or `~/.bashrc` (Linux) so the next time you open a console they are automatically available.
* `sbt ~run`

The output will be like

```
[info] play - Listening for HTTP on /0:0:0:0:0:0:0:0:9000

(Server started, use Ctrl+D to stop and go back to the console...)
```

{'fraction_non_alphanumeric': 0.14531754574811626, 'fraction_numerical': 0.015069967707212056, 'mean_word_length': 5.074074074074074, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6659437', 'n_tokens_mistral': 1001, 'n_tokens_neox': 943, 'n_words': 242}