Bienvenue sur En cas de soif. Cette application web permet de trouver les points d'eaux les plus proches. Que ce soit pour boire, mettre de l'eau sur un bobo ou même se laver, cette application communautaire saura répondre à vos attentes !
- Docker
$ docker pull loicrosso/en-cas-de-soif
$ docker run --rm --name EnCasDeSoif -p 8000:8000 \
-e MAPBOX_LOGIN='MyMapboxUsername' \
-e MAPBOX_PRIVATE_KEY='sk.MyMapBoxSecretKey' \
loicrosso/en-cas-de-soifGo to localhost:8000
- Python 3.7
- Pip
$ git clone https://github.com/Matissou/EnCasDeSoif
$ cd EnCasDeSoif
# Modifiez le fichier .env avec votre login et clé d'api Mapbox
# Sourcez le fichier .env
$ source .env
#installer les dépendances
$ pip install -r requirements.txt
# préparer la base de données
$ python manage.py makemigrations && python manage.py migrate
# lancer le serveur
$ python manage.py runserver --insecureGo to localhost:8000
Il est possible d'utiliser EnCasDeSoif en utilisant l'API REST suivante. Cette API est accessible via l'url <baseURL>/api/<path>
- Les cases marquées d'un 🚫 représentent une méthode d'API non valide pour une URL donnée.
- Les cases marquées d'un 🔒 représentent une méthode d'API qui nécessite une connection pour être utilisée (Basic AUTH par exemple avec votre user/password).
| <path> | GET | POST | PUT | DELETE |
|---|---|---|---|---|
| account/ | OK | 🚫 | 🚫 | 🚫 |
| account/<int:pk> | OK | 🔒 OK | 🔒 OK | 🔒 OK |
| pointsEau/ | OK | 🔒 OK | 🚫 | 🚫 |
| pointsEau/<int:pk> | OK | 🚫 | 🔒 OK | 🔒 OK |
Modèle de user pour interragir avec l'API :
{
"id": 1,
"username": "someOwner",
"pointseau": [1, 2, 8]
}Modèle de pointEau pour interragir avec l'API :
{
"pk": 1,
"nom": "Fontaine foot",
"lat": "43.09000000",
"long": "34.00000000",
"desc": "Une fontaine fort sympathique à côté des stades de foot !",
"owner": "someOwner"
}- Fork le projet et faire une PR
- Contribuer aux points d'eau sur l'application
Application propulsée dans l'espace par Lolo & Matisse