https://github.com/stephsako/fftt-api-typescript
🏓 Consommateur de l'API de la FFTT en TypeScript
https://github.com/stephsako/fftt-api-typescript
api-consumer api-rest fftt jest-tests nodejs npm-dependencies sport table-tennis typescript
Last synced: about 2 months ago
JSON representation
🏓 Consommateur de l'API de la FFTT en TypeScript
- Host: GitHub
- URL: https://github.com/stephsako/fftt-api-typescript
- Owner: StephSako
- Created: 2022-08-13T18:32:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-29T16:22:00.000Z (over 2 years ago)
- Last Synced: 2025-03-05T09:51:58.668Z (2 months ago)
- Topics: api-consumer, api-rest, fftt, jest-tests, nodejs, npm-dependencies, sport, table-tennis, typescript
- Language: TypeScript
- Homepage:
- Size: 350 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EN CONSTRUCTION !! Publication sur npm en fin d'année
FFTTApi, API Node.JS/TypeScript pour la FFTT
=============================
[](https://gitlab.com/al37350/ffttAPI/commits/master)
[](https://gitlab.com/al37350/ffttAPI/commits/master)
FFTTApi permet de consommer facilement l'API officielle de la Fédération Française de Tennis de table.
### Installation avec Composer
Il est recommandé d'installer FFTTApi grâce à composer
[Composer](http://getcomposer.org).
```bash
# Installer Composer
curl -sS https://getcomposer.org/installer | php
```
Puis, lancez la commande composer pour installer la dernière version stable de FFTTApi :
```bash
php composer.phar require al37350/fftt-api
```
Après l'installation, vous devez requérir l'autoloader de composer :
```php
require 'vendor/autoload.php';
```
Ainsi vous pouvez facilement mettre à jour le packet.
```bash
composer.phar update
```
### Exemple d'utilisation
```php
getJoueursByNom("Lamirault");
```
### Fonctionnalités
- Liste des organismes
- Liste des clubs par département
- Liste des clubs par nom
- Détail d'un club
- Lists des joueurs d'un club
- Liste des joueurs par nom, prénom
- Détail d'un joueur
- Classement d'un joueur
- Historique d'un joueur
- Liste des parties d'un joueur
- Liste des parties non validées d'un joueur
- Points virtuels d'un joueur
- Liste des équipes d'un club
- Classement d'une poule
- Liste des rencontres d'une poule
- Liste des prochaines rencontres d'une équipe
- Détail d'une rencontre
- Liste des actualitées
### Tests
Vous pouvez lancer les tests unitaires avec la commande suivante:
```bash
$ cd path/to/FFTTApi/
$ composer.phar install
$ cp tests/.env.dist tests/.env #Set your parameters
$ phpunit
```