https://github.com/papillonapp/papiapi
https://github.com/papillonapp/papiapi
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/papillonapp/papiapi
- Owner: PapillonApp
- Created: 2025-08-25T20:45:17.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-02-02T21:42:23.000Z (5 months ago)
- Last Synced: 2026-02-03T05:28:25.255Z (5 months ago)
- Language: Python
- Size: 34.1 MB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
Awesome Lists containing this project
README
# API de Papillon
## Utilisation de l'image Docker hub
Lancez le conteneur Docker :
```bash
docker run -d -p 3000:3000 vilerio/papillon-api:latest
```
## Utilisation du Dockerfile
Si vous préférez exécuter l'API dans un conteneur Docker, suivez ces étapes :
Assurez-vous d'avoir Docker installé sur votre système.
Clonez ce référentiel et accédez au répertoire du projet.
Construisez l'image Docker en exécutant la commande suivante :
```bash
docker build -t papillon-api .
```
Lancez le conteneur Docker :
```bash
docker run -d -p 3000:3000 papillon-api
```
## Utilisation de npx directement
Si vous préférez exécuter l'API directement sans Docker, suivez ces étapes :
Clonez ce référentiel et accédez au répertoire du projet.
Installez les dépendances avec la commande :
```bash
npm i
```
Lancez l'API en exécutant le fichier app.py :
```bash
npx ts-node api.ts
```
## Les différents endpoints
- GET /api : Version de l'api
- GET /team : Liste des membres de l'équipe
- GET /messages : Liste de tous les messages de l'app
- GET /latestVersion/plateforme : Dernière version de l'application pour la plateforme en question