Verified Commit 3a425c67 authored by Sli's avatar Sli
Browse files

documentation: add infos about fontawesome + tests instructions + more external doc

parent 88097531
......@@ -25,6 +25,10 @@ Python 3
Le python est un langage de programmation interprété multi paradigme sorti en 1991. Il est très populaire pour sa simplicité d'utilisation, sa puissance, sa stabilité, sécurité ainsi que sa grande communauté de développeur. Sa version 3, non rétro compatible avec sa version 2, a été publiée en 2008.
.. note::
Puisque toutes les dépendances du backend sont des packages Python, elles sont toutes ajoutées directement dans le fichier **requirements.txt** à la racine du projet.
Django
~~~~~~
......@@ -89,6 +93,21 @@ Sass (Syntactically Awesome Stylesheets) est un langage dynamique de génératio
C'est une technologie stable, mature et pratique qui ne nécessite pas énormément d'apprentissage.
Fontawesome
~~~~~~~~~~~
`Site officiel <https://fontawesome.com>`__
Fontawesome regroupe tout un ensemble d'icônes libres de droits utilisables facilement sur n'importe quelle page web. Ils sont simple à modifier puisque modifiables via le CSS et présentent l'avantage de fonctionner sur tous les navigateurs contrairement à un simple icône unicode qui s'affiche lui différemment selon la plate-forme.
.. note::
C'est une dépendance capricieuse qu'il évolue très vite et qu'il faut très souvent mettre à jour.
.. warning::
Il a été décidé de **ne pas utiliser** de CDN puisque le site ralentissait régulièrement. Il est préférable de fournir cette dépendance avec le site.
Documentation
-------------
......
......@@ -42,12 +42,33 @@ Bienvenue sur la documentation du Sith de l'AE
Documentations complémentaires
------------------------------
Python et Django
~~~~~~~~~~~~~~~~
* `Apprendre Python <https://openclassrooms.com/fr/courses/235344-apprenez-a-programmer-en-python>`__
* `Documentation de Django <https://docs.djangoproject.com/fr/1.11/>`__
* `Classy Class-Based Views <http://ccbv.co.uk/projects/Django/1.11/>`__
HTML/Jinja/JS/(S)CSS
~~~~~~~~~~~~~~~~~~~~
* `Cours sur le javascript <https://openclassrooms.com/fr/courses/2984401-apprenez-a-coder-avec-javascript>`__
* `Cours sur jQuery <https://openclassrooms.com/fr/courses/1631636-simplifiez-vos-developpements-javascript-avec-jquery>`__
* `Cours sur le HTML et CSS <https://openclassrooms.com/fr/courses/1631636-simplifiez-vos-developpements-javascript-avec-jquery>`__
* `Documentation sur les grilles CSS <https://developer.mozilla.org/fr/docs/Web/CSS/CSS_Grid_Layout>`__
* `Guide pour le SASS <https://sass-lang.com/guide>`__
* `Documentation de fontawesome <https://fontawesome.com/how-to-use/on-the-web/referencing-icons/basic-use>`__
* `Documentation pour Jinja2 <https://jinja.palletsprojects.com/en/2.10.x/>`__
Git
~~~
* `Cours sur Git <https://openclassrooms.com/fr/courses/2342361-gerez-votre-code-avec-git-et-github>`__
* `Livre sur Git <http://www.git-scm.com/book/fr/v2>`__
Documents téléchargeables
-------------------------
......
......@@ -84,3 +84,22 @@ Pour l'utiliser en local ou globalement pour la modifier, il existe une commande
.. sourcecode:: bash
./manage.py documentation
Lancer les tests
----------------
Pour lancer les tests il suffit d'utiliser la commande intégrée à django.
.. code-block:: bash
# Lancer tous les tests
./manage.py test
# Lancer les tests de l'application core
./manage.py test core
# Lancer les tests de la classe UserRegistrationTest de core
./manage.py test core.tests.UserRegistrationTest
# Lancer une méthode en particulier de cette même classe
./manage.py test core.tests.UserRegistrationTest.test_register_user_form_ok
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment