Giter Club home page Giter Club logo

dora-front's Introduction

dora-front

Pré-requis

  • Node.js
  • npm
  • GitGuardian

Installation

  • Installer GitGuardian ;
  • Copier le fichier .env-example en .env ;
  • Renseigner la variable VITE_API_URL dans le fichier .env ;
    • La valeur "https://api.dora.incubateur.net" permet de connecter le front sur la preprod et ainsi éviter une mise en place locale du back ;
  • Renseigner la variable GITGUARDIAN_API_KEY avec une clé d'API générée sur GitGuardian.com.
# Installer les dépendances
npm install

Développement

# Lancer un serveur de développement accessible sur localhost:3000
npm run dev

Testing - e2e

Merci de vous reporter au README : ./e2e/README.md.

Contribution

# Installer les hooks de pre-commit
npm run prepare

Dépannage

Lorsque je clique sur Référencer un service, la page est blanche et j'ai l'erreur TypeError: error loading dynamically imported module dans la console

Cela est peut-être dû à une extension de navigateur qui bloque des contenus nécessaires au bon fonctionnement : sveltejs/kit#3308 (comment)

Organisation des fichiers

routes

Chaque répertoire correspond à une route, selon la norme Svelkit, mais on a regroupé les fichiers statiques (documents légaux, etc.) dans le repertoire (static), et les differents endpoints (fichiers robots.txt, sitemap.xml, etc.) dans le repertoire (endpoints).

D'autres regroupements pourraient être envisagés, par exemple services et modeles, pour faciliter la réutilisation de code localement.

lib

  • assets: toutes les ressources (fontes, icones, images…)
  • components
    • display: tous les composants génériques d'affichage (boutons, labels, etc.)
    • forms: composants dédiés à l'affichage et à la validation des formulaire
    • hoc: composants de hauts niveau
    • inputs: composants d'entrée (hors validation -- ils sont encapsulés dans le repertoire /form/fields si nécessaire)
      • obsolete: composants qui font doublon avec un autre. À nettoyer, et à ne pas utiliser!!
    • specialized: composants spécialisés, qui seraient plus à leur place directement dans /routes, mais utilisés par plusieurs routes.
  • requests: s'occupent de l'interaction avec l'API. À terme toutes les requetes à l'API devraient être faites ici plutôt qu'inline.
  • utils: utilitaires variés. Éviter des mettre des fonctions qui ne servent qu'à un seul endroit.
  • validation: gestion de la validation des formulaires
    • schema: les schemas déterminent les règles de validation des differents formulaire, ainsi que certaines valeurs d'affichage par defaut.
  • env.ts: gestion des variables d'environnement
  • icons.ts: chargement des icones
  • types.ts: liste des types typescript partagés.

dora-front's People

Contributors

cedricr avatar alexandrecantin avatar francoisromain avatar ikarius avatar ggounot avatar dependabot[bot] avatar marc-gavanier avatar scttpr avatar jonathanperret avatar vmttn avatar

Stargazers

 avatar

Watchers

 avatar Andrei Bocan avatar  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.