lucidworks view

Vue Lucidworks

LucidWorks View est un frontal orienté consommateur pour Lucidworks Fusion. Il fournit une interface de recherche de base avec une configuration simple, vous pouvez donc fournir rapidement une solution de recherche basée sur une fusion avec un développement minimal. La vue est alimentée par la fusion, la gorgée, l'angulaire et la libsass.

Vous pouvez également utiliser la vue comme base pour développer une interface Web plus sophistiquée, en utilisant Foundation for Apps: http://foundation.zurb.com/apps/docs/

Si vous avez besoin d'aide pour configurer Fusion, consultez https://doc.lucidworks.com/. Pour poser des questions sur la vue, consultez le site de questions et réponses LucidWorks.

Exigences

Si vous avez téléchargé un package spécifique à la plate-forme, toutes les dépendances sont incluses. Sautez pour commencer l'étape 4.

Si vous commencez par cloner le référentiel, vous aurez besoin du logiciel suivant:

• Node.js: utilisez l'installateur pour votre système d'exploitation. Utilisez la version 5.xxx.
• Git (si vous clonez le repo): utilisez l'installateur pour votre système d'exploitation.
• Les utilisateurs de Windows peuvent également essayer Git pour Windows.
• Gulp et Bower: Exécutez npm install -g gulp bower
• Selon la façon dont le nœud est configuré sur votre machine, vous devrez peut-être exécuter sudo npm install -g gulp bower à la place, si vous obtenez une erreur avec la première commande.

Commencer

1. Clone le référentiel, où app est le nom de votre application:

git clone https://github.com/lucidworks/lucidworks-view app

1. Se transformer dans le répertoire:

 cd app

1. Installez les dépendances:

npm install
bower install

1. Pendant que vous travaillez sur votre projet, exécutez:

• Si vous avez téléchargé un package TAR:

  ./view.sh start

• Si vous avez cloné le référentiel:

  npm start

Cela compilera le SASS, assemblera votre application angulaire et créera FUSION_CONFIG.js (si vous ne l'avez pas déjà créée). Vous verrez une sortie qui vous indique quel port a été sélectionné:

 [BS] Access URLs:
 ------------------------------------
       Local: http://localhost:3000
    External: http://<external IP>:3000
 ------------------------------------

La valeur par défaut est le port 3000, mais si ce port est déjà utilisé, l'application sélectionne le port le plus élevé disponible.

1. Maintenant, allez sur http://localhost:<port> dans votre navigateur pour le voir en action.

La première fois que vous parcourez l'application, vous verrez une page de connexion. Utilisez votre nom d'utilisateur et votre mot de passe Fusion. Pour activer l'accès anonyme, modifiez les clés anonymous_access dans Fusion_Config.js.

Lorsque vous modifiez Fusion_config.js ou tout fichier dans le dossier client , la tâche Gulp appropriée s'exécutera pour créer de nouveaux fichiers. Cela utilise browser-sync pour un rechargement instantané lors du changement de fichiers source. Visitez http://localhost:3001 (ou tout ce que votre terminal montre comme l'interface utilisateur de synchronisation du navigateur) pour le tableau de bord browser-sync .

Pour exécuter le processus de compilation une fois, sans regarder aucun fichier, utilisez la commande build :

npm run build

Cette commande crée une version construite de View qui peut être copiée du dossier de construction à un autre dossier / machine et a servi sur votre propre serveur Web.

À des fins de développement, vous pouvez vous développer sans une version minifiée en utilisant la commande

npm run start-dev

Cette commande exécute un serveur de nœuds, avec des packages minimisés, et fonctionne de manière similaire à la commande npm start .

Tests unitaires

 npm run build
npm test

Configuration de base

La première fois que vous exécutez npm start , Fusion_Config.sample.js est copié sur fusion_config.js. Modifiez ce fichier pour configurer les options de base de la vue. La documentation sur les clés de configuration est incluse dans le fichier.

Au minimum, vous devez configurer la clé collection pour correspondre au nom de votre collection de fusion.

Dans un environnement de production, vous devez également configurer host et port pour pointer vers le service d'interface utilisateur de votre déploiement de fusion. La valeur par défaut est localhost:8764 à des fins de développement.

Lorsque l'application est en cours d'exécution avec Browsersync, il recharge la configuration à chaque fois que vous enregistrez Fusion_Config.js. Vous pouvez modifier la configuration et regarder le changement d'application en temps réel dans votre navigateur.

Personnalisation de base

Le titre et le logo de votre interface sont configurés dans fusion_config.js en tant que search_app_title et logo_location .

Les options CSS sont configurées dans les fichiers dans le client / actifs / SCSS.

Les modèles pour divers composants d'interface utilisateur sont situés dans le client / les actifs / composants.

Les résultats de recherche de différents types de documents peuvent utiliser différents modèles. Le client/assets/components/document Directory contient des modèles pour certains types de documents courants, ainsi que des modèles par défaut pour tous les autres. Les types de données correspondent aux connecteurs de la fusion. Voir la personnalisation des documents pour plus de détails sur le travail avec ces derniers.

Afficher sur Windows

Téléchargez le dernier installateur de vue à partir de https://github.com/lucidworks/lucidworks-view/releases et exécutez-le en tant qu'administrateur .

Quelle est la prochaine étape

Pour plus de détails sur la configuration et la personnalisation de la vue, consultez le répertoire DOCS.

Contributions

La vue est open source! Tirez les demandes de bienvenue. C'est un excellent moyen de redonner à la communauté et d'aider les autres à créer une meilleure application de recherche.