Skip to content

Commit

Permalink
[kb] đź“„ Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
KyllianBeguin authored Nov 17, 2024
1 parent 467a412 commit 0581672
Showing 1 changed file with 42 additions and 53 deletions.
95 changes: 42 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,42 @@
Template DataForGood
================

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

This file will become your README and also the index of your
documentation.

# Contributing


## Use a venv

python3 -m venv name-of-your-venv

source name-of-your-venv/bin/activate


## Utiliser Poetry

[Installer Poetry](https://python-poetry.org/docs/):

python3 -m pip install "poetry==1.4.0"

Installer les dépendances:

poetry install

Ajouter une dépendance:

poetry add pandas

Mettre à jour les dépendances:

poetry update

## Utiliser Jupyter Notebook

jupyter notebook

and check your browser !

## Lancer les precommit-hook localement

[Installer les precommit](https://pre-commit.com/)


pre-commit run --all-files


## Utiliser Tox pour tester votre code

tox -vv
```
_____ YAao,
|__ /___ _ __ ___ Y8888b,
/ // _ \ '__/ _ \ ,oA8888888b,
/ /| __/ | | (_) | ,aaad8888888888888888bo,
/____\___|_| \___/ _ _ ,d888888888888888888888888888b,
| _ \ ___ ___| |__ ___| |_ ,888888888888888888888888888888888b,
| | | |/ _ \/ __| '_ \ / _ \ __| d8888888888888888888888888888888888888,
| |_| | __/ (__| | | | __/ |_ d888888888888888888888888888888888888888b
|____/_\___|\___|_| |_|\___|\__| d888888P' `Y888888888888,
/ ___| __ _ _ ___ ____ _ __ _ ___ 88888P' Ybaaaa8888888888l
\___ \ / _` | | | \ \ / / _` |/ _` |/ _ \ a8888' `Y8888P' `V888888
___) | (_| | |_| |\ V / (_| | (_| | __/ d8888888a `Y8888
|____/ \__,_|\__,_| \_/ \__,_|\__, |\___| AY/'' `\Y8b ``Y8b
|___/ Y' `YP ~~
```

# ZĂ©ro DĂ©chat Sauvage
## À propos
[Zéro Déchet Sauvage](http://zds-app.duckdns.org/) (ZDS) est une application de visualisation de données de déchets diffus et collectés au cours d'évènements de collectes. Il s'agit d'une plateforme appartenant à l'association [MerTerre](https://mer-terre.org/) et développée par des bénévoles de l'association Data For Good.

## DĂ©mo
Une démo de l'applicaiton a été réalisée lors du Demo Day organisée à la fin de la saison 12 par Data For Good.

<a href="[URL](https://www.youtube.com/live/7Zvy2PS7Vjg?si=Z3Gduxff0EunXsF7&t=6210)">
<img src="https://i.ytimg.com/vi/7Zvy2PS7Vjg/maxresdefault.jpg?sqp=-oaymwEmCIAKENAF8quKqQMa8AEB-AH-CYAC0AWKAgwIABABGFUgTyhlMA8=&rs=AOn4CLC3vkFGSd9jcNDb0HxMvbdN8kxQyA" alt="video youtube du demo day" width="50%">
</a>

## Remerciement
Merci à l'équipe de développement :
* [Floriane](https://github.com/florianeduccini)
* [Hadrien](https://github.com/DridrM)
* [Mehdi](https://github.com/Mendi33)
* [Vincent](https://github.com/Vincentdata)
* [Thibault](https://github.com/tgazagnes)
* [Linh](https://github.com/linh-dinh-1012)
* [Joaquim](https://github.com/JoaquimDiaz)
* [Valérie](https://github.com/ValerieNevo)
* [Kyllian](https://github.com/KyllianBeguin)

## Licence
Ce projet est sous licence MIT. Plus d'information sur le fichier [LICENCE](https://github.com/dataforgoodfr/12_zero_dechet_sauvage/blob/staging/LICENSE).

0 comments on commit 0581672

Please sign in to comment.