klask io

Bifurquer	Construire	Couverture
maître
développer

Docker

Qu'est-ce que Klask.io?

KLASK.IO est un moteur de recherche open source pour le code source. Cette application a été générée à l'aide de Jhipster.

Démo en direct

http://app.klask.io/

Comment l'exécuter?

Vous pouvez exécuter une instance facilement en tirant l'image Docker et en exécutant en suivant:

 docker run klask/klask.io

composer docker

Un exemple de docker-compose.yml:

version: '2'
services:
  klask-app:
    image: klask/klask.io:latest
    ports:
      - 8080:8080
    volumes:
      - /mnt/svn:/repo
      - ./data:/klask-data
      - ./application-docker.yml:/application-docker.yml

/mnt/svn est le chemin de mes référentiels
./data est l'emplacement où les fichiers Elasticsearch et la base de données ont été enregistrés.
Le fichier facultatif application-docker.yml peut remplacer toutes les propriétés définies dans Application.yml et Application-Docker.yml

Développement

Avant de pouvoir créer ce projet, vous devez installer et configurer les dépendances suivantes sur votre machine:

1. Node.js: nous utilisons Node pour exécuter un serveur Web de développement et construire le projet. Selon votre système, vous pouvez installer le nœud à partir de la source ou en tant que bundle préemballé.

Après avoir installé le nœud, vous devriez être en mesure d'exécuter la commande suivante pour installer des outils de développement (comme Bower et Browsersync). Vous n'aurez besoin d'exécuter cette commande que lorsque les dépendances changent dans package.json. Nous utilisons Gulp comme système de construction. Installez l'outil de ligne de commande Gulp à l'échelle mondiale avec:

 npm install
npm install -g gulp
npm install -g bower
bower update
bower install
gulp

Exécutez les commandes suivantes dans deux terminaux distincts pour créer une expérience de développement béat où votre navigateur refrouve automatiquement lorsque les fichiers changent sur votre disque dur.

 ./mvnw
gulp

Bower est utilisé pour gérer les dépendances CSS et JavaScript utilisées dans cette application. Vous pouvez mettre à niveau les dépendances en spécifiant une version plus récente dans bower.json . Vous pouvez également exécuter bower update et bower install pour gérer les dépendances. Ajoutez l'indicateur -h sur n'importe quelle commande pour voir comment vous pouvez l'utiliser. Par exemple, bower update -h .

Bâtiment pour la production

Pour optimiser le client KLASK.IO pour la production, exécutez:

 ./mvnw -Pprod clean package

Cela concatera et minivera les fichiers CSS et JavaScript. Il modifiera également index.html afin qu'il fait référence à ces nouveaux fichiers.

Pour vous assurer que tout fonctionnait, exécutez:

 java -jar target/*.war --spring.profiles.active=prod

Accédez ensuite à http: // localhost: 8080 dans votre navigateur.

Essai

Les tests unitaires sont effectués par Karma et écrits avec du jasmin. Ils sont situés dans src/test/javascript/ et peuvent être exécutés avec:

 gulp test

Pour courir avec Docker en production:

Utiliser Les Fichiers Docker-Compose dans SRC / Main / Docker

 docker-compose -f elasticsearch.yml up -d
docker-compose -f postgresql.yml up -d

java -jar target/*.war --spring.profiles.active=prod

Intégration continue

Pour configurer ce projet dans Jenkins, utilisez la configuration suivante:

• Nom du projet: klask.io
• Gestion du code source
  • Référentiel Git: https://github.com/klask-io/klask-io.git
  • Branches à construire: */master
  • Comportements supplémentaires: Wipe out repository & force clone
• Construire des déclencheurs
  • Sondage SCM / Calendrier: H/5 * * * *
• Construire
  • Invoquez Maven / Tâches: -Pprod clean package
• Actions post-construction
  • Publier le rapport sur le résultat du test Junit / Rapport de test XMLS: build/test-results/*.xml