application-amicale/README.md

89 lines
5.6 KiB
Markdown
Raw Permalink Normal View History

2020-08-09 15:49:45 +02:00
<img src="https://etud.insa-toulouse.fr/~amicale_app/images/promo/Banner.png" alt="banner" width="500"/>
2020-08-08 19:59:50 +02:00
[<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)
[<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)
2019-06-25 21:43:36 +02:00
2020-08-10 14:38:39 +02:00
2020-08-08 19:59:50 +02:00
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 :
- Connexion à son compte Amicale
2020-03-08 16:31:12 +01:00
- Liste des événements sur le campus
2020-08-09 15:49:45 +02:00
- État des machines à laver
- Emploi du temps
2020-08-08 19:59:50 +02:00
...et bien d'autres services
2020-08-08 19:59:50 +02:00
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).
2020-08-10 15:05:32 +02:00
## 🗨️ [Des questions ? Viens discuter sur Discord !](https://discord.gg/W8MeTec)
2020-08-10 14:38:39 +02:00
2020-08-14 17:58:00 +02:00
## ️☑️ [Organisation sur Trello](https://trello.com/b/RMej49Uq/application-campus-insa)
2020-08-14 17:55:52 +02:00
2020-08-09 15:49:45 +02:00
# 🔎 Besoin de mainteneur
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.
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.
Le tout, bien sûr, permet de valoriser une implication citoyenne 😉.
# 🚀 Contribuer
2020-08-14 17:55:52 +02:00
**Tu veux influencer le développement ? C'est très simple !** Tu trouveras une liste de choses à faire sur [Trello](https://trello.com/b/RMej49Uq/application-campus-insa).
2020-08-08 19:59:50 +02:00
#### 🙃 Aucune connaissance ?
2020-08-10 14:43:31 +02:00
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)), sur [Discord](https://discord.gg/W8MeTec), ou sur [cette page](https://git.etud.insa-toulouse.fr/vergnet/application-amicale/issues) en te connectant avec tes login INSA.
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
#### 🌍 Bilingue ou plus ?
2020-08-10 14:43:31 +02:00
Tu peux aider à traduire l'application ! Le projet existe en français et anglais (mais il peut y avoir des fautes !), et toute autre langue est la bienvenue.
2020-08-09 15:49:45 +02:00
2020-08-09 16:04:14 +02:00
Si tu es intéressé, rends-toi sur [cette page](doc/TRANSLATE.md) pour plus de détails.
2020-08-09 15:49:45 +02:00
2020-08-08 19:59:50 +02:00
#### 🤓 Développeur dans l'âme ?
2020-08-09 15:49:45 +02:00
Peu importe ton niveau, toutes les propositions de modification sont les bienvenues ! (enfin presque)
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
Pour cela, [suis ce guide](doc/CONTRIBUTE.md).
2020-08-08 19:59:50 +02:00
#### 🤯 Motivé mais perdu ?
2020-08-09 15:49:45 +02:00
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)).
2020-08-08 19:59:50 +02:00
## 👨‍💻 Technologies Utilisées
Cette application est faite en JavaScript avec React Native (framework Open Source créé par Facebook).
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...)
2020-08-09 15:49:45 +02:00
Tu trouveras [une liste de liens utiles](doc/LINKS.md) pour retrouver toutes les infos !
2020-08-08 19:59:50 +02:00
2020-08-09 15:52:30 +02:00
# 💾 [Installer l'application sur ton téléphone depuis ce dépot](doc/INSTALL.md)
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
# 📔️ [Notes de changement](Changelog.md)
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
# 🗒️ [Notes sur l'état actuel du projet](doc/NOTES.md)
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
# 🔗 [Liens Utiles](doc/LINKS.md)
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
# 🤝 Contributeurs
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
| <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"/> | ❔ |
|--------------------------------|--------------------------------|-------------------------------------------|
2020-08-09 15:52:30 +02:00
| **Arnaud Vergnet** | **Yohan Simard** | **Toi ?** |
2020-08-09 16:04:14 +02:00
| Créateur et mainteneur actuel | Correction de quelques bugs | [Contribue pour faire vivre le projet !](doc/CONTRIBUTE.md) |
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
# 👏 Remerciements
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
* **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.
* **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 🦊.
* **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.
* **Titouan Labourdette** : Étudiant en IR (2020). Il a beaucoup aidé pour trouver des bugs et proposer des nouvelles fonctionnalités.
* **Théo Tami** : Étudiant en AE (2020). Si l'application marche sur iOS, c'est grâce à son aide lors de ses nombreux tests.
2020-08-08 19:59:50 +02:00
2020-08-09 15:49:45 +02:00
# 📄 Licence
2020-08-09 15:49:45 +02:00
L'application est **Open Source** sous licence **GPLv3**.
2020-08-09 15:49:45 +02:00
# 🔐 Copyright
2020-08-08 19:59:50 +02:00
Apple and Apple Logo are trademarks of Apple Inc.
2020-06-23 21:03:26 +02:00
2020-08-08 19:59:50 +02:00
Google Play et le logo Google Play sont des marques de Google LLC.