Skip to content

revuedepresse/org.revue-de-presse.api

Revue de presse

🇬🇧 Revue-de-presse.org serves press titles curated daily from official French Media Twitter accounts.

All development is delivered under free and open-source software licence.

🇫🇷 Revue-de-presse.org est un projet citoyen indépendant qui s'adresse à toute personne curieuse de l'actualité et de l'influence des médias sur l'opinion.

revue-de-presse.org continuous integration

HTTP API

API serving daily short lists (10 items) of top news in France sorted by popularity.
Said popularity is simply based on retweets fetched by calling Twitter APIs.

Installation

The shell scripts written for bash
have been tested extensively with Ubuntu 22.10 (Kinetic Kudu)
and Debian 11 (Bullseye)

Requirements

Install git by following instructions from the official documentation.

Install Docker by following instructions from the official documentation.

Install Docker compose by following instructions from the official documentation.

Documentation

make help

Build application

export COMPOSE_PROJECT_NAME='org_revue-de-presse_api' \
SERVICE='org.revue-de-presse.api' && \
make build

Start application

export COMPOSE_PROJECT_NAME='org_revue-de-presse_api' \
SERVICE='org.revue-de-presse.api' && \
make start

Execute shell in service container

docker exec -ti $(docker ps -a | grep 'api[-]service' | awk '{print $1}') bash

License

GNU General Public License v3.0 or later

See COPYING to see the full text.

Acknowledgment

We're grateful towards all amazing contributors involved in the following
communities, organizations and projects (in lexicographic order):

About

API serving daily short lists (10 items) of top news in France sorted by popularity.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors

Languages