https://github.com/liaad/contamehistorias-api
https://github.com/liaad/contamehistorias-api
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/liaad/contamehistorias-api
- Owner: LIAAD
- License: gpl-3.0
- Created: 2021-02-12T15:43:52.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-07T00:04:21.000Z (almost 5 years ago)
- Last Synced: 2025-01-08T01:48:06.789Z (over 1 year ago)
- Language: Python
- Size: 43.9 MB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Web application
[](https://www.python.org/)
The [conta-me historias](http://contamehistorias.pt/arquivopt/) web application depends on:
- the front-end [user interface](https://github.com/LIAAD/contamehistorias-ui)
- the back-end API to retrieve data (this repository)
See [UI](https://github.com/LIAAD/contamehistorias-api) for instructions on how to run the front-end server.
### Setup
It is recommended to setup a [virtual environment](https://docs.python.org/3.8/library/venv.html).
The API uses a RedisJSON server as cache system. While the back-end still works without cache, it is recommended to run the Redis server, for a better experience. See [RedisJSON](https://github.com/RedisJSON/RedisJSON) for instructions on how to run the server.
#### Install requirements
```shell
$ pip install -r requirements.txt
```
#### Run server
```shell
$ cd api/
```
Directly from python
```shell
$ python app.py
```
or through Gunicorn
```shell
$ sh run.sh
```
### LIAAD dependencies
This project uses the following LIAAD software:
- [Conta-me Historias Temporal Summarization](https://github.com/LIAAD/TemporalSummarizationFramework)
- [PAMPO](https://github.com/LIAAD/py-pampo)
