Commit 9dff0436 authored by Mahdi Sellami's avatar Mahdi Sellami
Browse files

update README

parent f9a36e49
# idea-service
The idea service is a micro-service that suggests similar ideas to a given idea using a specified (standardised) Idea-DB as ideas set.
## Introduction
## Example
> The idea service is a micro-service that suggests similar ideas to a given idea using a specified (standardised) Idea-DB as ideas set. The similarity is computed based on the keywords of the ideas.
POST request `/similarIdeas`
## Installation
```sh
$ pip install -r requirements.txt
$ python app.py
```
> The following message should be then displayed:
```sh
Debug mode: on
Running on http://0.0.0.0:10002/ (Press CTRL+C to quit)
Restarting with stat
Debugger is active!
Debugger PIN: 161-064-190
```
## Usage
POST request to `/similarIdeas`
Body:
```
{
......@@ -16,7 +37,7 @@ POST request `/similarIdeas`
}
```
Result
Result:
```
[
......@@ -178,4 +199,7 @@ Result
]
}
]
```
\ No newline at end of file
```
## License
> [MIT](https://choosealicense.com/licenses/mit/)
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment