|
|
@@ -1,87 +1,82 @@
|
|
1
|
|
-
|
|
|
1
|
+<img src="https://etud.insa-toulouse.fr/~amicale_app/images/promo/Banner.png" alt="banner" width="500"/>
|
|
|
2
|
+
|
|
2
|
3
|
[<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
|
4
|
[<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)
|
|
4
|
5
|
|
|
5
|
6
|
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
|
7
|
- Connexion à son compte Amicale
|
|
8
|
|
- - État des machines à laver
|
|
9
|
8
|
- Liste des événements sur le campus
|
|
10
|
|
- - Stock du Proximo
|
|
|
9
|
+ - État des machines à laver
|
|
11
|
10
|
- Emploi du temps
|
|
12
|
|
- - Menu du RU
|
|
13
|
|
- - Disponibilité des salles libre accès
|
|
14
|
|
- - Réservation des Bib'Box
|
|
15
|
11
|
|
|
16
|
12
|
...et bien d'autres services
|
|
17
|
13
|
|
|
18
|
|
-L'application est **Open Source** sous licence **GPLv3**.
|
|
19
|
|
-
|
|
20
|
14
|
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
|
15
|
|
|
22
|
|
-## 🚀 Contribuer
|
|
|
16
|
+# 🔎 Besoin de mainteneur
|
|
|
17
|
+
|
|
|
18
|
+Ce projet a été réalisé en grande partie par **un seul étudiant**, mais cet étudiant (coucou c'est moi) ne va pas rester éternellement à l'INSA. **Il faut donc une relève !** Le projet étant stable, le minimum est de corriger les bugs rencontrés.
|
|
|
19
|
+
|
|
|
20
|
+Tout le monde peut contribuer, mais **il faut tout de même au moins une personne pour gouverner le projet** : accepter les modifications, compiler et mettre en ligne sur les magasins. Pas besoin d'énormément de connaissance, seulement de la motivation.
|
|
|
21
|
+
|
|
|
22
|
+Le tout, bien sûr, permet de valoriser une implication citoyenne 😉.
|
|
|
23
|
+
|
|
|
24
|
+# 🚀 Contribuer
|
|
23
|
25
|
|
|
24
|
26
|
**Tu veux influencer le développement ? C'est très simple !**
|
|
25
|
27
|
|
|
26
|
28
|
#### 🙃 Aucune connaissance ?
|
|
27
|
29
|
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
|
30
|
|
|
|
31
|
+#### 🌍 Bilingue ou plus ?
|
|
|
32
|
+
|
|
|
33
|
+Tu peux aider à traduire l'application ! Le projet existe en français et anglais (mais il peut y avoir des fautes !), et tout autre langue est la bienvenue.
|
|
|
34
|
+
|
|
|
35
|
+Si tu es intéressé, rends-toi sur [cette page]() pour plus de détails.
|
|
|
36
|
+
|
|
29
|
37
|
#### 🤓 Développeur dans l'âme ?
|
|
30
|
|
-Toutes les propositions de modification sont les bienvenues ! (enfin presque)
|
|
|
38
|
+Peu importe ton niveau, toutes les propositions de modification sont les bienvenues ! (enfin presque)
|
|
31
|
39
|
|
|
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)).
|
|
|
40
|
+Pour cela, [suis ce guide](doc/CONTRIBUTE.md).
|
|
33
|
41
|
|
|
34
|
42
|
#### 🤯 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)).
|
|
|
43
|
+Tu es quand même le bienvenu ! Tu trouveras [une liste de liens](doc/LINKS.md) 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
|
44
|
|
|
37
|
45
|
## 👨💻 Technologies Utilisées
|
|
38
|
46
|
Cette application est faite en JavaScript avec React Native (framework Open Source créé par Facebook).
|
|
39
|
47
|
|
|
40
|
48
|
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...)
|
|
41
|
49
|
|
|
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
|
|
|
50
|
+Tu trouveras [une liste de liens utiles](doc/LINKS.md) pour retrouver toutes les infos !
|
|
51
|
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.
|
|
|
52
|
+# 💾 [Installer l'application sur votre téléphone depuis ce dépot](doc/INSTALL.md)
|
|
53
|
53
|
|
|
54
|
|
-#### Les bases
|
|
|
54
|
+# 📔️ [Notes de changement](Changelog.md)
|
|
55
|
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.
|
|
|
56
|
+# 🗒️ [Notes sur l'état actuel du projet](doc/NOTES.md)
|
|
57
|
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)
|
|
|
58
|
+# 🔗 [Liens Utiles](doc/LINKS.md)
|
|
62
|
59
|
|
|
63
|
|
-#### Comprendre les librairies
|
|
|
60
|
+# 🤝 Contributeurs
|
|
64
|
61
|
|
|
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.
|
|
|
62
|
+| <img src="https://secure.gravatar.com/avatar/8e33a1b2cedf7168e8468a1522cc8c56?d=identicon&s=290" alt="app-store" width="150"/> | <img src="https://secure.gravatar.com/avatar/9792c3643f98cddbc2a42e05422fe66e?d=identicon&s=290" alt="app-store" width="150"/> | ❔ |
|
|
|
63
|
+|--------------------------------|--------------------------------|-------------------------------------------|
|
|
|
64
|
+| **Arnaud Vergnet** | **Yohan Simard** | **Vous ?** |
|
|
|
65
|
+| Créateur et mainteneur actuel | Correction de quelques bugs | [Contribuez pour faire vivre le projet !](#contribuer) |
|
|
66
|
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
|
|
|
67
|
+# 👏 Remerciements
|
|
69
|
68
|
|
|
70
|
|
-#### Les Plus
|
|
|
69
|
+* **Béranger Quintana Y Arciosana** : Étudiant en AE (2020) et Président de l'Amicale au moment de la création et du lancement du projet. L'application, c'était son idée. Il a beaucoup aidé pour trouver des bugs, de nouvelles fonctionnalités et faire de la com.
|
|
|
70
|
+* **Céline Tassin** : Étudiante en GPE (2020). Sans elle, tout serait moins mignon. Elle a aidé pour écrire le texte, faire de la com, et aussi à créer la mascotte 🦊.
|
|
|
71
|
+* **Damien Molina** : Étudiant en IR (2020) et créateur de la dernière version du [site de l'Amicale](https://amicale-insat.fr/). Grâce à son aide, intégrer les services de l'Amicale à l'application a été très simple.
|
|
|
72
|
+* **Titouan Labourdette** : Étudiant en IR (2020). Il a beaucoup aidé pour trouver des bugs et proposer des nouvelles fonctionnalités.
|
|
|
73
|
+* **Théo Tami** : Étudiant en AE (2020). Si l'application marche sur iOS, c'est grâce à son aide lors de ses nombreux tests.
|
|
71
|
74
|
|
|
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.
|
|
|
75
|
+# 📄 Licence
|
|
82
|
76
|
|
|
|
77
|
+L'application est **Open Source** sous licence **GPLv3**.
|
|
83
|
78
|
|
|
84
|
|
-# Copyright
|
|
|
79
|
+# 🔐 Copyright
|
|
85
|
80
|
Apple and Apple Logo are trademarks of Apple Inc.
|
|
86
|
81
|
|
|
87
|
82
|
Google Play et le logo Google Play sont des marques de Google LLC.
|
