From ec0196fd24f8ce3e6bddbdd98209eda31e334574 Mon Sep 17 00:00:00 2001 From: Tykayn Date: Wed, 21 Dec 2022 18:56:28 +0100 Subject: [PATCH] improve getting started doc with config files --- README.md | 7 ++++--- docs/GETTING_STARTED.md | 28 ++++++++++++++++++++++++---- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d2bb2976..d4491ba4 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,10 @@ FR: Un logiciel libre de sondage fait par les contributeurs de l'association Fra EN: A libre polling software made by contributors around the French association Framasoft. This version uses a brand new backend API. - - - l'API de backend est en PHP / Symfony, ses sources disponible sur framagit https://framagit.org/tykayn/date-poll-api - +*** +> l'API de backend est en PHP / Symfony, ses sources disponible sur framagit + https://framagit.org/tykayn/date-poll-api +*** ## Pour débuter - getting started [lire la doc pour débuter votre Funky Framadate](docs/GETTING_STARTED.md) diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index 689bf948..bd6446ab 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -1,9 +1,12 @@ # Pour débuter - getting started -Clonez le dépot, installez les dépendances, et lancez le serveur local qui se recharge lorsque vous sauvegardez des fichiers dans le dépot. Les fois suivantes vous n'aurez qu'a lancer yarn start. +Clonez le dépot, installez les dépendances, et lancez le serveur local qui se recharge lorsque vous sauvegardez des fichiers dans le dépot. +Les fois suivantes vous n'aurez qu'a lancer `yarn start`. + ```bash -# clone the repo +# clonez le dépot git clone https://framagit.org/framasoft/framadate/funky-framadate-front.git cd funky-framadate-front + # install yarn curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list @@ -11,10 +14,27 @@ sudo apt-get update && sudo apt-get install yarn yarn install --pure-lockfile yarn start -# and now check your browser http://localhost:4200 +# et c'est parti, vous pouvez voir le site de développement http://localhost:4200 ``` -Pour interagir avec la base de données, il vous faudra également faire démarrer l'API Symfony de backend dans l'autre dépot, qui se lance par défaut sur le port 8000. +Pour interagir avec la base de données, il vous faudra également faire démarrer l'API Symfony de backend dans l'autre dépot https://framagit.org/tykayn/date-poll-api , +qui se lance par défaut sur le port 8000 avec une simple commande (si vous avez installé le tout) `symfony serve`. + +# Modifier les configurations par défaut + +Les configurations par défaut les plus générales telles que le nom du site ou les adresses d'API sont importées dans les fichiers d'environnement: + +[environment.ts par défaut](src/environments/environment.ts) + +Les propriétés par défaut des objets sont dans les modèles: + +[dossier des modèles](src/app/core/models) + +Et c'est le service en charge de la persistence de ces configurations et du stockage local qui surchage les propriétés des modèles quand une personne revient sur le site + +[storage.service.ts](src/app/core/services/storage.service.ts) # Pas de config docker Nous n'avons pas actuellement de config docker qui solutionnerait tout ça, les merge request sont les bienvenues! :) + +=> https://framagit.org/framasoft/framadate/funky-framadate-front