mirror of
https://codeberg.org/PostERG/xamxam.git
synced 2026-05-06 11:09:18 +02:00
Mise à jours et création de READMEs dédier.
This commit is contained in:
59
README.md
Normal file
59
README.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# PostERG - Monorepo
|
||||
|
||||
PostERG est un projet de l'ERG (École de Recherche Graphique) permettant aux étudiant.e.s sortant en cursus de Master de mettre à disposition leurs mémoires et travaux de fin d'études.
|
||||
|
||||
## Structure du projet
|
||||
|
||||
Ce monorepo contient deux applications :
|
||||
|
||||
- **[formulaire/](./formulaire/)** - Formulaire d'ajout de mémoires pour les étudiant.e.s
|
||||
- **[front-backend/](./front-backend/)** - Site web public affichant les mémoires soumis
|
||||
|
||||
## Prérequis
|
||||
|
||||
- PHP 7.4 ou supérieur
|
||||
- Composer (gestionnaire de dépendances PHP)
|
||||
|
||||
### Installation de Composer
|
||||
|
||||
```shell
|
||||
curl -sS https://getcomposer.org/installer | php
|
||||
```
|
||||
|
||||
ou
|
||||
|
||||
```shell
|
||||
php -r "readfile('https://getcomposer.org/installer');" | php
|
||||
```
|
||||
|
||||
ou installer le paquet `composer` de votre distribution.
|
||||
|
||||
## Installation
|
||||
|
||||
Chaque sous-projet a ses propres dépendances. Installez-les séparément :
|
||||
|
||||
```shell
|
||||
cd formulaire && composer install
|
||||
cd ../front-backend && composer install
|
||||
```
|
||||
|
||||
## Lancement en local
|
||||
|
||||
Pour chaque application, lancez un serveur PHP :
|
||||
|
||||
```shell
|
||||
# Pour le formulaire (port 3000)
|
||||
cd formulaire && php -S 127.0.0.1:3000
|
||||
|
||||
# Pour le site web (port 3001)
|
||||
cd front-backend && php -S 127.0.0.1:3001
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Documentation du formulaire](./formulaire/README.md)
|
||||
- [Documentation du site web](./front-backend/README.md)
|
||||
|
||||
## Liens
|
||||
|
||||
- [Site web PostERG](https://codeberg.org/PostERG/posterg-website)
|
||||
@@ -1,42 +1,40 @@
|
||||
# PostERG - Formulaire d'ajout de mémoires
|
||||
|
||||
Le formulaire a pour objectif de rendre possible au étudiant.e.s sortant de l'erg en cursus de Master, de mettre à disposition leur mémoires et travaux de fin d'études, dans le cadre du projet PostERG.
|
||||
Le formulaire permet aux étudiant.e.s sortant de l'ERG en cursus de Master de soumettre leurs mémoires et travaux de fin d'études.
|
||||
|
||||
Les métadonnées sont sauvegarder en format .yaml, et toutes les données sont téléversé sur un serveur interne à l'école, pour ensuite être afficher publiquement en ligne à travers [le siteweb PostERG](https://codeberg.org/PostERG/posterg-website).
|
||||
## Fonctionnalités
|
||||
|
||||
Le formulaire est en PHP, utilisant à la fois du css fait-main et [Simple.css](https://simplecss.org/). La librairie de traitement du YAML est [Symfony](https://symfony.com/doc/current/components/yaml.html).
|
||||
- Soumission de mémoires avec métadonnées
|
||||
- Sauvegarde des métadonnées en format YAML
|
||||
- Téléversement des fichiers sur le serveur interne de l'école
|
||||
|
||||
Pour installer toutes les dépendances citées dans `compose.json`, installer compose sur votre système:
|
||||
## Technologies
|
||||
|
||||
```shell
|
||||
curl -sS https://getcomposer.org/installer | php
|
||||
- PHP
|
||||
- CSS fait-main + [Simple.css](https://simplecss.org/)
|
||||
- [Symfony YAML](https://symfony.com/doc/current/components/yaml.html) pour le traitement des fichiers YAML
|
||||
|
||||
```
|
||||
ou
|
||||
```shell
|
||||
php -r "readfile('https://getcomposer.org/installer');" | php
|
||||
|
||||
```
|
||||
ou installer le paquet composer de votre distribution.
|
||||
|
||||
Puis naviguer jusqu'au dossier du projet dans un terminal et lancer la commande:
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
composer install
|
||||
|
||||
```
|
||||
|
||||
Il vous faudras un serveur php pour voir le site en local.
|
||||
|
||||
Pour cela, utiliser soit WAMP/MAMP/LAMP, soit installé php pour votre système et lancé dans le dossier du projet depuis un terminal la commande suivant:
|
||||
## Lancement
|
||||
|
||||
```shell
|
||||
php -S 127.0.0.1:3000
|
||||
```
|
||||
|
||||
Puis ouvrir [127.0.0.1:3000](http://127.0.0.1:3000) dans votre navigateur.
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
Ouvrer votre navigateur de choix (Firefox ;-) ) et entrer l'addresse:
|
||||
|
||||
formulaire/
|
||||
├── assets/ # Fichiers CSS et ressources
|
||||
├── data/ # Données stockées (YAML, fichiers)
|
||||
├── formulaire.php # Page principale du formulaire
|
||||
├── index.php # Point d'entrée
|
||||
└── thanks.php # Page de confirmation
|
||||
```
|
||||
127.0.0.1:3000
|
||||
```
|
||||
dans la barre d'URL.
|
||||
|
||||
44
front-backend/README.md
Normal file
44
front-backend/README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# PostERG - Site web public
|
||||
|
||||
Site web affichant publiquement les mémoires et travaux de fin d'études soumis par les étudiant.e.s de l'ERG.
|
||||
|
||||
## Fonctionnalités
|
||||
|
||||
- Affichage paginé des mémoires
|
||||
- Visualisation détaillée de chaque mémoire
|
||||
- Pages d'information (à propos, contact, licences)
|
||||
|
||||
## Technologies
|
||||
|
||||
- PHP
|
||||
- [Symfony YAML](https://symfony.com/doc/current/components/yaml.html) pour la lecture des métadonnées
|
||||
- CSS (Bulma)
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
composer install
|
||||
```
|
||||
|
||||
## Lancement
|
||||
|
||||
```shell
|
||||
php -S 127.0.0.1:3001
|
||||
```
|
||||
|
||||
Puis ouvrir [127.0.0.1:3001](http://127.0.0.1:3001) dans votre navigateur.
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
front-backend/
|
||||
├── assets/ # Fichiers CSS et ressources
|
||||
├── data/
|
||||
│ └── yaml/ # Fichiers YAML des mémoires
|
||||
├── inc/ # Fichiers inclus (header, footer)
|
||||
├── index.php # Page d'accueil avec liste paginée
|
||||
├── memoire.php # Page de détail d'un mémoire
|
||||
├── apropos.php # Page à propos
|
||||
├── contact.php # Page de contact
|
||||
└── licences.php # Page des licences
|
||||
```
|
||||
Reference in New Issue
Block a user