Browse Source

Improve readme

Arnaud Vergnet 1 year ago
parent
commit
962f629e02
1 changed files with 67 additions and 22 deletions
  1. 67
    22
      README.md

+ 67
- 22
README.md View File

@@ -1,7 +1,10 @@
1
-# CAMPUS - Application pour l'Amicale
1
+![](https://etud.insa-toulouse.fr/~amicale_app/images/promo/Banner.png)
2
+[<img src="https://etud.insa-toulouse.fr/~amicale_app/images/promo/app-store-badge.png" alt="app-store" width="150"/>](https://apps.apple.com/us/app/id1477722148)
3
+[<img src="https://etud.insa-toulouse.fr/~amicale_app/images/promo/google-play-badge.png" alt="google-play" width="150"/>](https://play.google.com/store/apps/details?id=fr.amicaleinsat.application)
2 4
 
3
-Créée pendant l'été 2019, cette application compatible Android et iOS permet aux étudiants d'avoir un accès facile aux informations du campus :
4
- - News de l'amicale
5
+Projet démarré pendant l'été 2019 par Arnaud Vergnet (alors en 3MIC), cette application compatible Android et iOS permet aux étudiants d'avoir un accès facile aux informations du campus :
6
+ - News de l'Amicale
7
+ - Connexion à son compte Amicale
5 8
  - État des machines à laver
6 9
  - Liste des événements sur le campus
7 10
  - Stock du Proximo
@@ -9,34 +12,76 @@ Créée pendant l'été 2019, cette application compatible Android et iOS permet
9 12
  - Menu du RU
10 13
  - Disponibilité des salles libre accès
11 14
  - Réservation des Bib'Box
12
- - Et d'autres services de l'INSA
13
- 
14
-Ce dépôt contient la source de cette application, sous licence GPLv3.
15 15
 
16
-## Contribuer
16
+...et bien d'autres services
17 17
 
18
-Vous voulez influencer le développement ? C'est très simple !
18
+L'application est **Open Source** sous licence **GPLv3**.
19 19
 
20
-Pas besoin de connaissance, il est possible d'aider simplement en proposant des améliorations ou en rapportant des bugs par mail ([app@amicale-insat.fr](mailto:app@amicale-insat.fr)) ou sur [cette page](https://git.etud.insa-toulouse.fr/vergnet/application-amicale/issues), en vous connectant avec vos login INSA.
20
+Pour la source du serveur utilisé pour synchroniser les informations, merci de voir [ce dépôt](https://git.etud.insa-toulouse.fr/vergnet/application-amicale-serveur).
21 21
 
22
-Si vous avez assez de connaissances et vous souhaitez proposer des modifications dans le code, [installez l'application](INSTALL.md) sur votre machine, réalisez votre modification et créez une 'pull request'. Si vous avez des problèmes ou des questions, n'hésitez pas à me contacter par mail ([app@amicale-insat.fr](mailto:app@amicale-insat.fr)).
22
+## 🚀 Contribuer
23 23
 
24
-## Technologies Utilisées
24
+**Tu veux influencer le développement ? C'est très simple !**
25
+
26
+#### 🙃 Aucune connaissance ?
27
+Pas de problème ! Tu peux aider simplement en proposant des améliorations ou en rapportant des bugs par mail ([app@amicale-insat.fr](mailto:app@amicale-insat.fr)), ou sur [cette page](https://git.etud.insa-toulouse.fr/vergnet/application-amicale/issues) en te connectant avec tes login INSA.
28
+
29
+#### 🤓 Développeur dans l'âme ?
30
+Toutes les propositions de modification sont les bienvenues ! (enfin presque)
31
+
32
+Pour cela, tu peux créer un fork de ce dépôt (en haut à droite), [installer l'application](INSTALL.md) sur ta machine, réaliser ta modification et créer une _pull request_. Si tu as des problèmes ou des questions, n'hésite pas à me contacter par mail ([app@amicale-insat.fr](mailto:app@amicale-insat.fr)).
33
+
34
+#### 🤯 Motivé mais perdu ?
35
+Tu es quand même le bienvenu ! Tu trouveras à [la fin de ce fichier ⤵️](#🔗-liens-utiles) une liste de liens pour t'aider à comprendre les technologies utilisées dans ce projet. Si tu as plus de questions, tu peux toujours me contacter par mail  ([app@amicale-insat.fr](mailto:app@amicale-insat.fr)). 
36
+
37
+## 👨‍💻 Technologies Utilisées
25 38
 Cette application est faite en JavaScript avec React Native (framework Open Source créé par Facebook).
26 39
 
27 40
 React Native permet de n'avoir qu'un seul code JavaScript à écrire pour Android et iOS. Pour compiler pour la plateforme souhaitée, il suffit d'effectuer une simple commande. Plus besoin de Mac pour développer une application iOS ! (Mais toujours besoin d'un pour compiler et publier sur l'App store...)
28 41
 
29
-Cette application utilisait initialement Expo, permettant de simplifier grandement le développement et le déploiement, mais il a été abandonné à cause de ses limitations et de son impact sur les performances. Revenir sur Expo n'est pas possible sans un gros travail et une suppression de fonctionnalités non compatibles.
42
+Tu trouveras une liste de liens utiles à [la fin de ce fichier ⤵️](#🔗-liens-utiles) pour retrouver toutes les infos !
43
+
44
+## 💾 [Installer l'application depuis ce dépot](INSTALL.md)
45
+
46
+## 📔️ [Notes de changement](Changelog.md)
47
+
48
+## 🗒️ [Notes sur l'état actuel du projet](NOTES.md)
49
+
50
+## 🔗 Liens utiles
51
+
52
+Voici une liste de liens qui pourraient t'être utile, que ce soit pour contribuer ou tout simplement pour comprendre comment l'application fonctionne sous le capot.
53
+
54
+#### Les bases
55
+
56
+Le strict minimum pour pouvoir comprendre le code de l'application.  Il n'est pas nécessaire d'avoir de grandes connaissances en JavaScript, Flow ou Git pour lire le code, mais une compréhension du fonctionnement et de la syntaxe de React Native est nécessaire pour faire quoi que ce soit.
57
+
58
+* [Tutoriel JavaScript](https://www.w3schools.com/js) : Un minimum de connaissances en JavaScript (ECMAScript 6) est nécessaire pour pouvoir comprendre le code
59
+* [Documentation React Native](https://reactnative.dev/docs/getting-started) : La techno de base, qui utilise JavaScript
60
+* [Tutoriel Git](https://www.tutorialspoint.com/git/index.htm) : Le système utilisé pour synchroniser le code entre plusieurs ordinateurs  
61
+* [Documentation Flow](https://flow.org/en/docs/react/) : Un utilitaire pour rendre JavaScript typé statique (c'est-à-dire plus robuste pour de gros projets)
62
+
63
+#### Comprendre les librairies
64
+
65
+Si tu as compris les bases et que tu veux te plonger un peu plus en profondeur dans le code, tu peux utiliser les liens ci-dessous pour accéder aux frameworks les plus importants.
66
+
67
+* [Documentation React Native Paper](https://callstack.github.io/react-native-paper/) : Le framework utilisé pour créer l'interface utilisateur (UI)
68
+* [Documentation React Navigation](https://reactnavigation.org/docs/getting-started) : Le framework utilisé pour faciliter la navigation classique entre différents écrans
69
+
70
+#### Les Plus
71
+
72
+Si t'es vraiment à fond dans le projet et que tu veux faire des trucs trop ouf, tu peux lire ça. Même moi j'ai eu la flemme de tout lire. 
73
+
74
+* [Documentation Jest](https://jestjs.io/docs/en/getting-started) : Framework de tests unitaires pour JavaScript
75
+
76
+#### Les Logiciels
77
+
78
+Tu ne sais pas trop quel logiciel utiliser ? C'est normal y'a beaucoup de choix, mais tu trouveras ici une liste très réduite de logiciels qui marchent bien pour le développement.
79
+
80
+* [Webstorm](https://www.jetbrains.com/webstorm/buy/#discounts?billing=yearly) : Un logiciel pas mal que j'utilise et gratuit pour les étudiants/projets open-source
81
+* [VSCodium](https://vscodium.com/) : Un logiciel plus simple/léger que Webstorm mais avec un peu moins de fonctionnalités.
30 82
 
31
-## [Installer l'application depuis ce dépot](INSTALL.md)
32 83
 
33
-## [Notes sur l'état actuel du projet](NOTES.md)
84
+# Copyright
85
+Apple and Apple Logo are trademarks of Apple Inc.
34 86
 
35
-## Liens utiles
36
-* [Tutoriel JavaScript](https://www.w3schools.com/js) (Un minimum de connaissances en JavaScript est nécessaire)
37
-* [Documentation React Native](https://reactnative.dev/docs/getting-started) (La techno de base)
38
-* [Documentation React Native Paper](https://callstack.github.io/react-native-paper/) (Le framework d'UI)
39
-* [Documentation React Navigation](https://reactnavigation.org/docs/getting-started) (Le framework de navigation entre écrans)
40
-* [Documentation Jest](https://jestjs.io/docs/en/getting-started) (Tests unitaires JavaScript)
41
-* [Documentation Flow](https://flow.org/en/docs/react/) (Utilitaire de typage statique pour JavaScript)
42
-* [Webstorm](https://www.jetbrains.com/webstorm/buy/#discounts?billing=yearly) (Un logiciel pas mal que j'utilise et gratuit pour les étudiants/projets open-source)
87
+Google Play et le logo Google Play sont des marques de Google LLC.

Loading…
Cancel
Save