Branch | Build | Coverage |
---|---|---|
master | ||
develop |
klask.io is an open source search engine for source code. This application was generated using JHipster.
You can run an instance easily by pulling the docker image and execute by following :
docker run klask/klask.io
an example of a 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
is the path to my repositories
./data
is the location where elasticsearch files and database were saved.
The optional file application-docker.yml
can overrides all properties defined in application.yml and application-docker.yml
Before you can build this project, you must install and configure the following dependencies on your machine:
- Node.js: We use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.
After installing Node, you should be able to run the following command to install development tools (like Bower and BrowserSync). You will only need to run this command when dependencies change in package.json. We use Gulp as our build system. Install the Gulp command-line tool globally with:
npm install
npm install -g gulp
npm install -g bower
bower update
bower install
gulp
Run the following commands in two separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.
./mvnw
gulp
Bower is used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by
specifying a newer version in bower.json
. You can also run bower update
and bower install
to manage dependencies.
Add the -h
flag on any command to see how you can use it. For example, bower update -h
.
To optimize the klask.io client for production, run:
./mvnw -Pprod clean package
This will concatenate and minify CSS and JavaScript files. It will also modify index.html
so it references
these new files.
To ensure everything worked, run:
java -jar target/*.war --spring.profiles.active=prod
Then navigate to http://localhost:8080 in your browser.
Unit tests are run by Karma and written with Jasmine. They're located in src/test/javascript/
and can be run with:
gulp test
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
To setup this project in Jenkins, use the following configuration:
- Project name:
klask.io
- Source Code Management
- Git Repository:
https://github.com/klask-io/klask-io.git
- Branches to build:
*/master
- Additional Behaviours:
Wipe out repository & force clone
- Git Repository:
- Build Triggers
- Poll SCM / Schedule:
H/5 * * * *
- Poll SCM / Schedule:
- Build
- Invoke Maven / Tasks:
-Pprod clean package
- Invoke Maven / Tasks:
- Post-build Actions
- Publish JUnit test result report / Test Report XMLs:
build/test-results/*.xml
- Publish JUnit test result report / Test Report XMLs: