<commit_before># ![Github Pulse](resources/icon.png) Github Pulse

Github Pulse is a status bar app for osx to help you keep your streaks, making a commit every day.

It shows a graph of your last month commits and how long is your current streak. Its icon also turns red if you haven't commited today yet, and by the end of the afternoon it'll remember you once, in case you still haven't commited.

![Screenshot 1](resources/screenshot1.png)
![Screenshot 2](resources/screenshot2.png)
![Screenshot 3](resources/screenshot3.png)

## Installation

Just download it [here](https://github.com/tadeuzagallo/GithubPulse/raw/master/dist/GithubPulse.zip) and copy to your applications folder

## What's being used

The application has a small shell of native code, written in Swift and renders a React app (using JSX) on a WebView and uses `window.location` redirects to communicate with the native app.

### 3rd party libraries (Front)

* React
* Webpack
* Stylus
* Octicons
* react-router
* Chart.js

### Pods

* IYLoginItem
* INPopoverController

## Building it locally

As mentioned above I'm using Swift and React, so you'll need to have XCode 6+ installed, Node and CocoaPods already installed in order to build.

### To get started:

* Clone the repo: `$ git clone https://github.com/tadeuzagallo/GithubPulse.git`
* Install the npm dependencies: `$ npm install`
* Install the pods: `$ cd widget && pod install`

### Debug building

The debug build points the WebView to `webback-dev-server` default address: `localhost:8080`, so in order to get it running

* Start the webpack dev server: `$ cd front && webpack-dev-server`
* Just build the app through XCode interface (Command line build step is yet to come)

### Release building

* Pack the front with webpack: `$ cd front && webpack`
* Go to XCode, on the `Product` menu, click and `Archive` and then `Export...` and  finally `Export as Mac Application`

Done!

## Credits and Motivation

I really believe commiting every day on an open source project is the best practice a developer can keep, so I made this project to show my love to Github and make I sure I never miss a commit! :D<commit_msg>Add note to README about pod setup<commit_after># ![Github Pulse](resources/icon.png) Github Pulse

Github Pulse is a status bar app for osx to help you keep your streaks, making a commit every day.

It shows a graph of your last month commits and how long is your current streak. Its icon also turns red if you haven't commited today yet, and by the end of the afternoon it'll remember you once, in case you still haven't commited.

![Screenshot 1](resources/screenshot1.png)
![Screenshot 2](resources/screenshot2.png)
![Screenshot 3](resources/screenshot3.png)

## Installation

Just download it [here](https://github.com/tadeuzagallo/GithubPulse/raw/master/dist/GithubPulse.zip) and copy to your applications folder

## What's being used

The application has a small shell of native code, written in Swift and renders a React app (using JSX) on a WebView and uses `window.location` redirects to communicate with the native app.

### 3rd party libraries (Front)

* React
* Webpack
* Stylus
* Octicons
* react-router
* Chart.js

### Pods

* IYLoginItem
* INPopoverController

## Building it locally

As mentioned above I'm using Swift and React, so you'll need to have XCode 6+ installed, Node and CocoaPods already installed in order to build.

### To get started:

* Clone the repo: `$ git clone https://github.com/tadeuzagallo/GithubPulse.git`
* Install the npm dependencies: `$ npm install`
* Install the pods: `$ cd widget && pod install`. If you haven't used pod before, you will need to run `pod setup` first.

### Debug building

The debug build points the WebView to `webback-dev-server` default address: `localhost:8080`, so in order to get it running

* Start the webpack dev server: `$ cd front && webpack-dev-server`
* Just build the app through XCode interface (Command line build step is yet to come)

### Release building

* Pack the front with webpack: `$ cd front && webpack`
* Go to XCode, on the `Product` menu, click and `Archive` and then `Export...` and  finally `Export as Mac Application`

Done!

## Credits and Motivation

I really believe commiting every day on an open source project is the best practice a developer can keep, so I made this project to show my love to Github and make I sure I never miss a commit! :D
{'fraction_non_alphanumeric': 0.0814006366530241, 'fraction_numerical': 0.005457025920873124, 'mean_word_length': 4.4241676942046855, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, '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': '3883210', 'n_tokens_mistral': 1318, 'n_tokens_neox': 1260, 'n_words': 619}