Skip to content
Snippets Groups Projects
Commit 6676f860 authored by Louis-Olivier Brassard's avatar Louis-Olivier Brassard
Browse files

Merge branch '35-documentation' into 'develop'

README : Mise à jour de la documentation

See merge request anthologie-palatine/anthologie-palatine-client!21
parents 7b128dbb d93a89bb
No related branches found
No related tags found
No related merge requests found
# Anthologie Palatine Client # Anthologie Palatine Client
Client 100% statique (html-css-javascript) pour interagir avec l'API de l'Anthologie Palatine. Client 100% statique (html-css-javascript) pour interagir avec l'API de l'Anthologie Palatine.
Une application [VueJS](https://vuejs.org/)
[Démo](http://pop.anthologiegrecque.org/) [**→ Démo**](http://pop.anthologiegrecque.org/)
_Documentation en route!_
## Prérequis ## Prérequis
...@@ -16,7 +15,13 @@ Installer les outils Node.js : ...@@ -16,7 +15,13 @@ Installer les outils Node.js :
npm install npm install
``` ```
Voilà, vous êtes prêt à développer! ## Production
```bash
npm run build
```
Les fichiers générés dans le dossier `dist/ ` (compressés/optimisés/etc.) sont alors prêts à déployer sur votre serveur de choix. 100% statique.
## Développement ## Développement
...@@ -28,6 +33,21 @@ npm run start ...@@ -28,6 +33,21 @@ npm run start
Pour quitter, faites simplement `ctrl + c` dans le terminal. Pour quitter, faites simplement `ctrl + c` dans le terminal.
### Arborescence de fichiers
- Tous les fichiers source sont dans le répertoire `src/`, à l'exception du fichier `index.html` (situé dans la racine du dépôt)
- Les composantes se situent dans le sous-dossier `components/`
- Généralement, chaque vue (ou route) possède sa propre composante (ex. `/auteurs` → `AuthorsComponent`)
- Les routes (`url`) sont gérées par le routeur dans `router`
- De plus petites composantes partagées se trouvent dans le sous-dossier `components/partials`
- Des fichiers statiques, tels que des images, se trouvent dans un autre dossier : `static`
### Configuration et opitmisation
L'application est bootstrappée avec [Webpack](https://webpack.js.org/).
Cela permet d'empaqueter les fichiers et de les optimiser suivant des pratiques (relativement…) standardisées.
Vous trouverez les fichiers de configuration dans le dossier racine `config`
## Conventions des branches ## Conventions des branches
Adhérer aux principes de [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/). Adhérer aux principes de [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/).
...@@ -57,11 +77,3 @@ Une fois les changements fusionnés (ne pas oublier de fusionner `--no-ff` pour ...@@ -57,11 +77,3 @@ Une fois les changements fusionnés (ne pas oublier de fusionner `--no-ff` pour
_Attention, ce sont des modifications rapides et ponctuelles!_ _Attention, ce sont des modifications rapides et ponctuelles!_
Une fois les changements fusionnés (ne pas oublier de fusionner `--no-ff` pour conserver l'historique des commits), créer l'étiquette correspondante (`git tag <x.y.z>`) et supprimer la branche de la nouvelle patch. Une fois les changements fusionnés (ne pas oublier de fusionner `--no-ff` pour conserver l'historique des commits), créer l'étiquette correspondante (`git tag <x.y.z>`) et supprimer la branche de la nouvelle patch.
## Production
```bash
npm run build
```
Les fichiers générés dans le dossier `dist/ ` (compressés/optimisés/etc.) sont alors prêts à déployer sur votre serveur de choix. 100% statique.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment