<commit_before># HubbleJS
[![Coverage Status](https://coveralls.io/repos/github/Polyneue/hubblejs/badge.svg?branch=master)](https://coveralls.io/github/Polyneue/hubblejs?branch=master)

HubbleJS is a customizable Node.js portfolio generator for developers that is powered by the Github API. 

## Features

* Quick and easy set up
* Static file output, to enable hosting from anywhere
* Personalize your Github data
* Standardized Github response, to easily create custom templates

## Default Site

HubbleJS comes bundled with a default theme that can be customized to reflect your personality. For more information on the default theme, checkout the repository [hubblejs-default-theme](https://github.com/Polyneue/hubblejs-default-theme).

![HubbleJS Default Theme - Dark](https://raw.githubusercontent.com/Polyneue/hubblejs-default-theme/master/examples/images/hubblejs-default-theme-dark-example-1.png)

## Getting Started

HubbleJS was created to allow for quick set up with minimal configuration. Following the steps below will have your site built within minutes.

* Generate a [Personal Access Token](https://github.com/settings/tokens)
    * HubbleJS requires access to both the Repo and User scopes
* Install HubbleJS into your project directory

```shell
npm install --save-dev hubble.js
```

* Require HubbleJS and provide the necessary configuration

```javascript
const Hubble = require('hubble.js');

// Configure the Hubble instance
const hubble = new Hubble({
  username: 'GH_USER_NAME',
  token: 'GH_PERSONAL_ACCESS_TOKEN'
});

// Generate the site
hubble.generator();
```

Following the above steps will configure HubbleJS, generate a site useing the default theme, and output the HTML to `./dist/index.html`. Configuration properties are optional unless otherwise noted.

## Configuration

There are a number of configuration options when instantiating a new HubbleJS instance.

```javascript<commit_msg>Fixing typo<commit_after># HubbleJS
[![Coverage Status](https://coveralls.io/repos/github/Polyneue/hubblejs/badge.svg?branch=master)](https://coveralls.io/github/Polyneue/hubblejs?branch=master)

HubbleJS is a customizable Node.js portfolio generator for developers that is powered by the Github API. 

## Features

* Quick and easy set up
* Static file output, to enable hosting from anywhere
* Personalize your Github data
* Standardized Github response, to easily create custom templates

## Default Site

HubbleJS comes bundled with a default theme that can be customized to reflect your personality. For more information on the default theme, checkout the repository [hubblejs-default-theme](https://github.com/Polyneue/hubblejs-default-theme).

![HubbleJS Default Theme - Dark](https://raw.githubusercontent.com/Polyneue/hubblejs-default-theme/master/examples/images/hubblejs-default-theme-dark-example-1.png)

## Getting Started

HubbleJS was created to allow for quick set up with minimal configuration. Following the steps below will have your site built within minutes.

* Generate a [Personal Access Token](https://github.com/settings/tokens)
    * HubbleJS requires access to both the Repo and User scopes
* Install HubbleJS into your project directory

```shell
npm install --save-dev hubble.js
```

* Require HubbleJS and provide the necessary configuration

```javascript
const Hubble = require('hubble.js');

// Configure the Hubble instance
const hubble = new Hubble({
  username: 'GH_USER_NAME',
  token: 'GH_PERSONAL_ACCESS_TOKEN'
});

// Generate the site
hubble.generate();
```

Following the above steps will configure HubbleJS, generate a site useing the default theme, and output the HTML to `./dist/index.html`. Configuration properties are optional unless otherwise noted.

## Configuration

There are a number of configuration options when instantiating a new HubbleJS instance.

```javascript
{'fraction_non_alphanumeric': 0.08639084048920115, 'fraction_numerical': 0.0005204267499349467, 'mean_word_length': 5.082278481012659, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, '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': '4834767', 'n_tokens_mistral': 1068, 'n_tokens_neox': 1009, 'n_words': 396}