<commit_before># Anime Notifier

[![Godoc reference][godoc-image]][godoc-url]
[![Go report card][goreportcard-image]][goreportcard-url]
[![Build status][travis-image]][travis-url]

## How to

### Prerequisites

* Install [Docker](https://www.docker.com/get-started) :whale:
* Install [Docker Compose](https://docs.docker.com/compose/install/) :whale:

### Installation

Download the source code:

```shell
git clone https://github.com/animenotifier/notify.moe.git && cd notify.moe
```

Download the developer tools:

```shell
docker pull animenotifier/notify.moe
```

Run the developer tools:

```shell
docker-compose run notify.moe
```

### Usage

Your home directory is mounted as `/my` inside Docker.

Usually you'd want to clone all repositories you use into a `projects` directory inside your home files. This directory can be accessed by both your favourite editor on the host machine and also inside Docker.

On your host:

* Fork the notify.moe repository on GitHub :new:
* Download the fork to your home directory :arrow_down:
* Enter the notify.moe directory: `cd notify.moe` :open_file_folder:
* Start the development tools `docker-compose run notify.moe` :whale:

Inside the docker container:

* Enter the notify.moe directory again `cd notify.moe` :open_file_folder:
* Compile TypeScript files using: `tsc` :shaved_ice:
* Start the web server using: `run` :pray:

The `run` binary is a file watcher that will restart the web server when it detects code changes.

### Networking

* Add `beta.notify.moe 127.0.0.1` to your `hosts` file :page_facing_up:
* If you're a Linux or Mac user, run `make ports` to forward ports :penguin:
* Otherwise, forward TCP port 4001 to 443 manually :thought_balloon:
<commit_msg>Switch port order in the docs<commit_after># Anime Notifier

[![Godoc reference][godoc-image]][godoc-url]
[![Go report card][goreportcard-image]][goreportcard-url]
[![Build status][travis-image]][travis-url]

## How to

### Prerequisites

* Install [Docker](https://www.docker.com/get-started) :whale:
* Install [Docker Compose](https://docs.docker.com/compose/install/) :whale:

### Installation

Download the source code:

```shell
git clone https://github.com/animenotifier/notify.moe.git && cd notify.moe
```

Download the developer tools:

```shell
docker pull animenotifier/notify.moe
```

Run the developer tools:

```shell
docker-compose run notify.moe
```

### Usage

Your home directory is mounted as `/my` inside Docker.

Usually you'd want to clone all repositories you use into a `projects` directory inside your home files. This directory can be accessed by both your favourite editor on the host machine and also inside Docker.

On your host:

* Fork the notify.moe repository on GitHub :new:
* Download the fork to your home directory :arrow_down:
* Enter the notify.moe directory: `cd notify.moe` :open_file_folder:
* Start the development tools `docker-compose run notify.moe` :whale:

Inside the docker container:

* Enter the notify.moe directory again `cd notify.moe` :open_file_folder:
* Compile TypeScript files using: `tsc` :shaved_ice:
* Start the web server using: `run` :pray:

The `run` binary is a file watcher that will restart the web server when it detects code changes.

### Networking

* Add `beta.notify.moe 127.0.0.1` to your `hosts` file :page_facing_up:
* If you're a Linux or Mac user, run `make ports` to forward ports :penguin:
* Otherwise, forward TCP port 443 to 4001 manually :thought_balloon:

{'fraction_non_alphanumeric': 0.11213872832369942, 'fraction_numerical': 0.007514450867052023, 'mean_word_length': 4.906143344709897, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '154890', 'n_tokens_mistral': 1153, 'n_tokens_neox': 1081, 'n_words': 405}