<commit_before>[日本語](README.ja.md)

# Naumanni
[![CircleCI](https://circleci.com/gh/naumanni/naumanni/tree/master.svg?style=svg)](https://circleci.com/gh/naumanni/naumanni/tree/master)
[![Test Coverage](https://codeclimate.com/github/naumanni/naumanni/badges/coverage.svg)](https://codeclimate.com/github/naumanni/naumanni/coverage)😢

Naumanni is a Web user interface specially designed for Mastodon. Just like Mastodon, users can easily launch from Docker and install freely.　Multiple instances can be managed horizontally, and in addition to easy-to-use SMS-like direct messaging functions, it plans to add AI and end-to-end encryption functions.　

![Screenshot](screenshot.png)


# Demo

https://naumanni.com/

# Version

0.1.1

# Features

Naumanni’s features include the following:

* Multiple instance management
* Docker functionality
* SMS-style direct messaging
* End-to-end message encryption (scheduled for 6/10 release)
* Automated CW Function for Toots using AI (scheduled for 6/10 release [Japan only])
* Automated NSFW function using AI (Scheduled for summer release)

# Who made this?

Naumanni is a collaborative project between UEI Corporation. and glucose inc.

* Concept and AI: [<EMAIL>](https://mstdn.onosendai.jp/@shi3z)
* Code : [<EMAIL>](https://oppai.tokyo/@shn)

# Setup

## Dependency

* yarn >= 0.23.4
* node >= v7.5.0
* docker >= 17.03

## Docker

```
$ docker pull naumanni/naumanni-standalone
$ docker run -it -p 8080:80 naumanni/naumanni-standalone
```

Now you can access to http://localhost:8080/ via web browser.


# Setup for Developer

## Install Prerequisites


```
$ brew install yarn
```

## Development

### Build project

```
$ pwd
/path/to/naumanni
$ yarn
$ yarn run build
```

### Serve project

<details>
<summary> Example (serve app with nginx) </summary>

### Install nginx

```
$ brew install nginx
$ mkdir -p /usr/loca/var/run/nginx/proxy_temp
$ echo '127.0.0.1 naumanniskine.localdev' >> /etc/hosts
```

#### project tree

```
.
├── README.md
├── coverage
│   ├── clover.xml
│   ├── coverage-final.json
│   ├── lcov-report<commit_msg>Fix README description about running local nginx<commit_after>[日本語](README.ja.md)

# Naumanni
[![CircleCI](https://circleci.com/gh/naumanni/naumanni/tree/master.svg?style=svg)](https://circleci.com/gh/naumanni/naumanni/tree/master)
[![Test Coverage](https://codeclimate.com/github/naumanni/naumanni/badges/coverage.svg)](https://codeclimate.com/github/naumanni/naumanni/coverage)😢

Naumanni is a Web user interface specially designed for Mastodon. Just like Mastodon, users can easily launch from Docker and install freely.　Multiple instances can be managed horizontally, and in addition to easy-to-use SMS-like direct messaging functions, it plans to add AI and end-to-end encryption functions.　

![Screenshot](screenshot.png)


# Demo

https://naumanni.com/

# Version

0.1.1

# Features

Naumanni’s features include the following:

* Multiple instance management
* Docker functionality
* SMS-style direct messaging
* End-to-end message encryption (scheduled for 6/10 release)
* Automated CW Function for Toots using AI (scheduled for 6/10 release [Japan only])
* Automated NSFW function using AI (Scheduled for summer release)

# Who made this?

Naumanni is a collaborative project between UEI Corporation. and glucose inc.

* Concept and AI: [<EMAIL>](https://mstdn.onosendai.jp/@shi3z)
* Code : [<EMAIL>](https://oppai.tokyo/@shn)

# Setup

## Dependency

* yarn >= 0.23.4
* node >= v7.5.0
* docker >= 17.03

## Docker

```
$ docker pull naumanni/naumanni-standalone
$ docker run -it -p 8080:80 naumanni/naumanni-standalone
```

Now you can access to http://localhost:8080/ via web browser.


# Setup for Developer

## Install Prerequisites


```
$ brew install yarn
```

## Development

### Build project

```
$ pwd
/path/to/naumanni
$ yarn
$ yarn run build
```

### Serve project

<details>
<summary> Example (serve app with nginx) </summary>

### Install nginx

```
$ brew install nginx
$ mkdir -p /usr/local/var/run/nginx/proxy_temp
$ echo '127.0.0.1 naumanniskine.localdev' >> /etc/hosts
$ nginx -p `pwd` -c `pwd`/etc/dev/nginx/nginx.conf -g "daemon off;"
```

#### project tree

```
.
├── README.md
├── coverage
│   ├── clover.xml
│   ├── coverage-final.json
│   ├── lcov-report
{'fraction_non_alphanumeric': 0.13851193261581657, 'fraction_numerical': 0.01731399157697707, 'mean_word_length': 4.264778325123153, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 23, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6998503', 'n_tokens_mistral': 1603, 'n_tokens_neox': 1470, 'n_words': 413}