Giter Club home page Giter Club logo

mauria's Introduction

Mauria (Client mobile)

Code de l'application mobile Mauria

Technologies utilisées

  • Ionic (React) v6.5.0
  • Sass Modules
  • Capacitor v4.6.1
  • TypeScript v4.9.4

Structure du projet

Nous avons séparé le répertoire en plusieurs dossiers :

  • resources : contient le logo de l'application
  • public : contient la version du build actuelle
  • src : contient le code de l'application

Au sein de src se trouve un projet React "standard" :

  • assets : contient les SVGs utilisés
  • components : contient les composants réutilisables dans l'application
  • contexts : contient la structure des modals utilisés
  • pages : contient les différentes pages de l'application
  • theme : contient le CSS, ici du SCSS
  • types : contient les différents types de structure utilisés suivant les pages
  • utils : contient les différents fichiers "utile" au bon fonctionnement de l'application, comme les fonctions d'appel aux api, aux retours haptiques...

Installation

Prérequis

  • NodeJS v18+
  • npm et/ou yarn
  • TypeScript v4+

Installation

  1. Cloner le repo
  2. Se placer dans le dossier du projet : cd app
  3. Installer les dépendances : npm i

Lancement

Dans un navigateur

  1. Lancer le projet : npm start
  2. Le projet est accessible à l'adresse suivante : http://localhost:3000

Sur iOS/iPadOS (nécessite un Mac et un compte développeur Apple)

  1. Ouvrir le projet dabs XCode : ionic capacitor open ios
  2. Signer le projet avec votre compte développeur Apple (dans Signing & Capabilities)
  3. (Optionnel) Changer le bundle ID (A FAIRE SI ERREUR DE BUNDLE ID)
  4. Lancer le projet sur un simulateur ou un appareil connecté avec ionic capacitor run ios -l --external
    (-l permet de lancer le projet en mode live-reload et --external de lancer le projet sur un appareil connecté en USB)
  5. Choisir l'appareil sur lequel lancer l'application
  6. L'application se lance sur l'appareil (il se peut que vous deviez accepter le certificat de l'application dans les paramètres de l'appareil)

Sur Android

Demander à Milo de compléter...

Roadmap

  • Passage sous Ionic v5+
  • Suppression d'un événement ajouté au calendrier (=> création d'un modal lors du clic sur un cours)
  • Actualisation automatique des données (le plugin étant très récent, il présente de nombreux soucis actuellement...)
  • Un "agenda" permettant de noter des notes et/ou travaux à effectuer
  • Ajouter un feed d'événements Junia sur la page principal (cela pour but de partager et découvrir les prochains événements Junia sans passer par tous les réseaux sociaux)
  • Faire une version optimisée pour iPads et tablettes
  • Ajouter un message si une mise à jour est disponible (il faut stocker la version de l'application dans le localStorage et un appel à l'api permet de savoir si une mise à jour est disponible)
  • Ajouter un modal au lancement, si update pour expliquer les nouveautés de la dernière mise à jour
  • Implémenter des tests unitaires et d'intégration

Contribution

Pour contribuer au projet, il faut faire un fork du repo à partir de la branche pre-release. Une fois votre fork créé, vous pouvez travailler sur votre fork Pour proposer vos changements, vous devez faire une pull request sur la branche pre-release du repo principal.

Si votre contribution est acceptée, elle sera déployée dans la prochaine mise à jour de l'application ! (Nous essayons de limiter le nombre de mise à jour de l'application)

License

Ce projet est sous licence GNU v3. Pour plus d'informations, voir le fichier LICENSE à la racine du projet.

mauria's People

Contributors

louislecouturier avatar mylowmntr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.