Skip to content

Commit

Permalink
documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
quim-motger authored Nov 12, 2019
1 parent 36f34c8 commit e1649bd
Showing 1 changed file with 11 additions and 18 deletions.
29 changes: 11 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,17 @@ The classification service relies on two different technologies that are used to

### How to install

#### Docker installation

The project includes a Dockerfile for running an instance of the requirements-classifier service. In order to build and run the service with Docker, run the following commands:

```docker-compose build```
```docker-compose up```

You can make sure the Docker image is running successfully by checking the status with:

```docker container ls```

#### Manual installation

The project includes an isolated, integrated version of Hadoop and Mahout. In order to use them, it is necessary to configure the following steps:
Expand Down Expand Up @@ -146,24 +157,6 @@ mvn clean install package

Make sure Hadoop is up and running. Otherwise, tests will fail.

#### Docker installation

The project includes a Dockerfile for running an instance of the requirements-classifier service.

Before running the Docker image, go to the root folder of the repository and edit the required configuration files according to what is described in *Manual Installation > 1. Configuration*:

- *docker/environment.txt*
- *docker/hadoop-env.sh*
- *docker/hdfs-site.xml*

In order to build and run the service with Docker, run the following command:

```docker-compose up```

You can make sure the Docker image is running successfully by checking the status with:

```docker container ls```

### How to use it

You can take a look at the Swagger documentation [here](https://api.openreq.eu/requirements-classifier/swagger-ui.html), which includes specific, technical details of the REST API to communicate to the service.
Expand Down

0 comments on commit e1649bd

Please sign in to comment.