Skip to content
Snippets Groups Projects
README.md 2.88 KiB
Newer Older
  • Learn to ignore specific revisions
  • Tifenn Guillas's avatar
    Tifenn Guillas committed
    # ANIS-CLIENT
    
    François Agneray's avatar
    François Agneray committed
    
    ## Introduction
    
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    AstroNomical Information System, ou ANIS, est une suite d'outils web génériques qui visent à faciliter la mise à
    disposition de données astrophysiques, accessibles depuis une base de données, à une communauté de scientifiques.
    
    François Agneray's avatar
    François Agneray committed
    
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    ANIS-CLIENT est un composant de la suite ANIS qui permet de visualiser les datasets à travers un navigateur web.
    A partir des informations contenues dans la base de metamodel, ANIS-CLIENT est capable :
    - d'afficher la liste des datasets disponibles pour une instance donnée.
    - de générer un formulaire de recherche sur un dataset en sélectionnant des critères ainsi que les résultats à afficher.
    - de visualiser et télécharger les résultats de la recherche et informations associées.
    - d'afficher les informations détaillées d'un objet à travers des graphes ou des images par exemple.
    
    François Agneray's avatar
    François Agneray committed
    
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    ANIS est protégée par la licence CeCILL (voir le fichier [LICENCE](LICENCE)).
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    
    
    ## Installation
    
    ### Prérequis
    
    Avant de commencer l'installation, assurez-vous d'avoir les commandes suivantes installées sur votre système :
    
    - `make`
    - `docker`
    
    Une connexion internet sera nécessaire afin de télécharger les dépendances.
    
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    ### Installation et démarrage de l'application en mode développement
    
    ANIS-CLIENT contient un Makefile qui aide à l'installation et au démarrage de l'application.
    
    1. Pour installer l'application et ces dépendances, taper à la racine du projet :
    
    > make install
     
    2. Lancer l'application :
    
    > make start
    
    3. Stopper l'application :
    
    > make stop
    
    **Attention** : ANIS-CLIENT repose sur ANIS-SERVER pour fonctionner !
    
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    ### Liste des commandes
    
    Le fichier `Makefile` situé à la racine du projet rend disponible une liste de commandes utiles à la gestion de
    l'application en mode développement.
    
    Pour voir la liste des commandes disponibles, ouvrir un terminal à la racine du projet et taper :
    
    > make
    
    **Attention** : ces commandes sont destinées à être utilisées en mode développement uniquement !
    
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    ### Mode production
    
    Pour compiler le projet pour de la production, il existe une commande make pour générer le dossier `dist` à la racine :
    
    > make build
    
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    ## Technologies
    
    Voici une liste non exhaustive des principales dépendances utilisées lors du développement d'ANIS-CLIENT :
    
    * `Angular` : [https://angular.io](https://angular.io/)
    * `NGRX` : [https://ngrx.io](https://ngrx.io/)
    * `Bootstrap` : [https://getbootstrap.com](https://getbootstrap.com)
    * `D3.js` : [https://d3js.org](https://d3js.org)
    * `Docker` : [https://www.docker.com](https://www.docker.com)
    * `GIT` : [http://git-scm.com](http://git-scm.com)
    * `CeCILL`: [http://www.cecill.info/index.en.html](http://www.cecill.info/index.en.html)
    
    
    François Agneray's avatar
    François Agneray committed
    
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    ## Auteurs
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    
    
    François Agneray's avatar
    François Agneray committed
    * `François Agneray` : Laboratoire d'Astrophysique de Marseille (CNRS)
    
    Tifenn Guillas's avatar
    Tifenn Guillas committed
    * `Chrystel Moreau` : Laboratoire d'Astrophysique de Marseille (CNRS)
    * `Tifenn Guillas` : Laboratoire d'Astrophysique de Marseille (CNRS)