<commit_before># Hymn Factory
![](screenshot.png)
![](screenshot_2.png)

<img src="screenshot.png" width=300"> &nbsp;
<img src="screenshot_2.png" width=300">

## Why its awesome
This is a community maintained project. Built on top of Yeoman, Gulp, Bower, AngularJS, Ionic & of course Cordova.

## Contributing
There are two ways to contribute to this project.
  1. Maintaining the song database 
  2. App development
  
### Maintaining the song database
The whole song database is located in the `db` directory. Modifications/Additions can be done via pull requests. The only requirement is that the same standard and formatting is following. See the song specification section for details on this (TODO), or look at existing songs.

### App development
Since this is a community effort, the whole architecture is built around the github ecosystem. 

![Architecture](https://www.lucidchart.com/publicSegments/view/1d6383c0-8324-43a3-ba83-e07922cf47b3/image.png)
    
The API is a simple wrapper for the github API. Since the github API requires authentication, I've wrapped the db endpoints in the API which the App can interact with. This is simple express server and its located in the `server` directory.

**Note:** When developing locally, a local server can be run

#### Developing locally

##### Prerequisites<commit_msg>set image width<commit_after># Hymn Factory
![](screenshot.png =300px)
![](screenshot_2.png =200px)

## Why its awesome
This is a community maintained project. Built on top of Yeoman, Gulp, Bower, AngularJS, Ionic & of course Cordova.

## Contributing
There are two ways to contribute to this project.
  1. Maintaining the song database 
  2. App development
  
### Maintaining the song database
The whole song database is located in the `db` directory. Modifications/Additions can be done via pull requests. The only requirement is that the same standard and formatting is following. See the song specification section for details on this (TODO), or look at existing songs.

### App development
Since this is a community effort, the whole architecture is built around the github ecosystem. 

![Architecture](https://www.lucidchart.com/publicSegments/view/1d6383c0-8324-43a3-ba83-e07922cf47b3/image.png)
    
The API is a simple wrapper for the github API. Since the github API requires authentication, I've wrapped the db endpoints in the API which the App can interact with. This is simple express server and its located in the `server` directory.

**Note:** When developing locally, a local server can be run

#### Developing locally

##### Prerequisites
{'fraction_non_alphanumeric': 0.07662538699690402, 'fraction_numerical': 0.025154798761609906, 'mean_word_length': 4.656455142231947, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, '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': '2781351', 'n_tokens_mistral': 753, 'n_tokens_neox': 690, 'n_words': 340}