<commit_before>Cookbook Backend
================

> Boring line-of-business application for storing recipes

Simplest RESTful application in the world, just a 
wrapper around interactions with a database.

License: MIT.

This is largely intended for _me_ to run on an infrastructure provider 
(eg, DigitalOcean), but I am working to make sure that it can be reasonably 
run locally ([self-hosted](https://github.com/Kickball/awesome-selfhosted)) as well.

Usage
-----
At the moment, there isn't a binary distribution of this project. Eventually, it 
will be distributed as a Docker image. To build the Docker image, see the 
[Development](#Development) section. 


Development
-----------
The project is built using Gradle, with the wrapper file checked in to the repo. 
Assuming that you have Java 1.8+ installed, you can work on this project just by 
running `./gradlew` in the root directory of the project.

If you are familiar with [Dropwizard](https://dropwizard.io), you will be very 
comfortable with this project. 

* To run tests: `./gradlew check`. If you are a TDD kind of person, 
  `./gradlew check -t` will re-run the tests on file changes.
* If you see style violations as a result of the tests, you can use 
  `./gradlew spotlessApply` to fix them.
* To compile a binary that you can run, use `./gradlew install`. The shell script 
  to start the server will be put at `$rootDir/server/build/install/server/bin/server`.
* To build a Docker image, use `./gradlew dockerBuildImage`. This will build an image 
  named `ptrteixeira/cookbook:...`.
  
  <commit_msg>Add table of contents<commit_after>Cookbook Backend
================

> Boring line-of-business application for storing recipes

Simplest RESTful application in the world, just a 
wrapper around interactions with a database.

License: MIT.

This is largely intended for _me_ to run on an infrastructure provider 
(eg, DigitalOcean), but I am working to make sure that it can be reasonably 
run locally ([self-hosted](https://github.com/Kickball/awesome-selfhosted)) as well.

Table of Contents
-----------------
1. [Usage](#usage)
1. [Development](#development)
1. [Running the Server](#running-the-server)
1. [Configuration](#configuration)
1. [How I run the application with Docker](#how-i-run-the-application-with-docker)

Usage
-----
At the moment, there isn't a binary distribution of this project. Eventually, it 
will be distributed as a Docker image. To build the Docker image, see the 
[Development](#Development) section. 


Development
-----------
The project is built using Gradle, with the wrapper file checked in to the repo. 
Assuming that you have Java 1.8+ installed, you can work on this project just by 
running `./gradlew` in the root directory of the project.

If you are familiar with [Dropwizard](https://dropwizard.io), you will be very 
comfortable with this project. 

* To run tests: `./gradlew check`. If you are a TDD kind of person, 
  `./gradlew check -t` will re-run the tests on file changes.
* If you see style violations as a result of the tests, you can use 
  `./gradlew spotlessApply` to fix them.
* To compile a binary that you can run, use `./gradlew install`. The shell script 
  to start the server will be put at `$rootDir/server/build/install/server/bin/server`.
* To build a Docker image, use `./gradlew dockerBuildImage`. This will build an image 
  named `ptrteixeira/cookbook:...`.
  
  
{'fraction_non_alphanumeric': 0.10228604923798358, 'fraction_numerical': 0.002637749120750293, 'mean_word_length': 3.7337031900138697, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 7, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4363701', 'n_tokens_mistral': 1017, 'n_tokens_neox': 934, 'n_words': 462}