CofeehousePy/README.md

45 lines
1.3 KiB
Markdown
Raw Normal View History

2020-12-25 20:19:00 +01:00
# CoffeeHousePy
CoffeeHousePy is the full Python implementation for CoffeeHouse, and it's server
components. The [Makefile](Makefile) contains all the setup procedures
2020-12-25 21:34:45 +01:00
used in order to install CoffeeHousePy, and it's components onto the machine.
## Prepare the system
2020-12-27 23:06:07 +01:00
The system must have `python3.6` installed, `pip` and `gcc`. To prepare the system run
2020-12-27 23:22:32 +01:00
the following command, this is designed to run on Ubuntu 18.04
2020-12-25 21:34:45 +01:00
```shell
sudo make system_prep_python system_prep_pip system_prep_gcc
```
## Install CoffeeHousePy
Depending on the hardware, the installation procedure may take a while. To install
CoffeeHousePy run the following command
```shell
sudo -H make clean build install
2020-12-27 23:06:07 +01:00
```
## Services
Once CoffeeHousePy is installed, you can start it's services indvidually.
```shell
make start_langdetect # Starts the language detection server, runs on port 5606
make start_spamdetect # Starts the spam detection server, runs on port 5601
make start_translate # Starts the translation server, runs on port 5603
```
### Services Ports
| Name | Protocol | Port |
|--------------------------------|----------|------|
| CoffeeHouse Language Detection | HTTP | 5606 |
| CoffeeHouse Spam Detection | HTTP | 5601 |
2021-01-09 04:24:32 +01:00
| CoffeeHouse Translate | HTTP | 5603 |
| CoffeeHouse CoreNLP | HTTP | 5604 |