https://github.com/aeecleclair/centralassociation
New website to browse ECL's student associations' links
https://github.com/aeecleclair/centralassociation
Last synced: 3 months ago
JSON representation
New website to browse ECL's student associations' links
- Host: GitHub
- URL: https://github.com/aeecleclair/centralassociation
- Owner: aeecleclair
- License: mit
- Created: 2024-09-18T10:04:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-23T00:35:47.000Z (over 1 year ago)
- Last Synced: 2025-03-13T05:17:46.819Z (over 1 year ago)
- Language: HTML
- Homepage: https://assos.myecl.fr
- Size: 8.32 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Centralassociation
Le site Web Centralassociation sert d’agrégateur de liens pour les Centraliens : sur cette même page sont centralisés les liens vers les réseaux sociaux et autres sites de chaque association de l'école.
## Le projet
La page principale est générée automatiquement par un script `Python` (3.9) et utilise la librairie `Jinja2` pour automatiser l'écriture du `html`. Une documentation complète de la librairie est disponible sur le site officiel. Cependant, notre projet emploie uniquement les fonctionnalités de base.
Le choix d'une génération automatique s'explique par la redondance du code HTML de la page et dans l'ambition de faire un projet clair, facilement compréhensible et modifiable.
Pour faire bref :
- Les différents liens, leurs noms et descriptions sont écrits au format `YAML` dans le fichier [assos_links.yaml](./assos_links.yaml).
- Le script Python `build.py` lit le fichier YAML et construit la page HTML à partir de celui-ci.
- Le fichier final est enregistré dans le dossier `./dist` aux côtés des feuilles de styles CSS et des images.
Afin de faciliter la gestion l'adaptabilité de la page en fonction des thèmes et des différentes résolutions d'écrans, la feuille de style de la page est générée avec `tailwind`.
## Environnement de compilation
Pour mettre à jours le site, clonez le projet sur votre PC.
```bash
git clone https://github.com/aeecleclair/Centralassociation.git
```
Déplacez-vous dans le dossier du projet
```bash
cd ./centralassociation
```
Modifiez le fichier `assos_links.yaml` à votre guise.
Pour construire la page il faut exécuter le script Python. Assurez-vous d'avoir `Python3.9` où supérieur installé avec la librairie `Jinja2` et `PyYAML`. L'utilisation d'un environnement virtuel avec [Poetry](https://python-poetry.org/) permet d'installer ces éléments.
Pour modifier le style de la page, assurez vous d'avoir installé `tailwind` via `npm`, il vous suffit alors de modifier les élements de style dans le fichier `src/index.html`, puis de générer la nouvelle feuille de style avec
```bash
npx tailwindcss -i ./src/input.css -o ./src/assets/stylesheet.css --minify
```
ou
```bash
npm run dev
```
qui s'occupera également de la compilation.
## Compilation
Avec Poetry :
```bash
poetry run python ./build.py
```
Sinon simplement,
```bash
python ./build.py
```
Récupérer le résultat dans le dossier `./dist`