From 46d9475ca82af7ed51b3bd3d976e9ecdb2e7283d Mon Sep 17 00:00:00 2001 From: Febbweiss Date: Thu, 11 Jan 2018 11:57:32 +0100 Subject: [PATCH] Feature: add small projects --- src/docs/development/java_small_projects.md | 54 +++++++++++++++++++++ src/docs/development/library_reader.md | 47 ++++++++++++++++++ src/docs/index.md | 3 ++ 3 files changed, 104 insertions(+) create mode 100644 src/docs/development/java_small_projects.md create mode 100644 src/docs/development/library_reader.md diff --git a/src/docs/development/java_small_projects.md b/src/docs/development/java_small_projects.md new file mode 100644 index 0000000..7964ad6 --- /dev/null +++ b/src/docs/development/java_small_projects.md @@ -0,0 +1,54 @@ +#Introduction +In this section, I introduce some small Java projects + +## Rabbits vs Hunter + +Source : GitHub repository + +### Goal + +This projects manages a rabbit hunt. +It's possible to change some criteria such as trees, burrows and rabbits counts. + + +### Building + +Using maven, just execute the following command : +``` +mvn clean package +``` + +In the new _target_ folder, you will find the _rabbits-vs-hunter-[version]-jar-with-dependencies.jar_ jar file. This jar contains all dependencies. + +### Running + +Execute the built jar : +``` +java -jar rabbits-vs-hunter-[version]-jar-with-dependencies.jar +``` + +## Word lister + +Source : GitHub repository + +### Goal + +This project prints all words in a file, one per line. +All compound words and numbers are preserved (such as _byte-input_ and _-5.52%_ for example). + +### Building + +Using maven, just execute the following command : +``` +mvn clean package +``` + +In the new _target_ folder, you will find the _word-lister-[version]-jar-with-dependencies.jar_ jar file. This jar contains all dependencies. + +### Running + +Execute the built jar with the _--help_ parameter to display the help message. +To parse a file, execute the following command : +``` +java -jar word-lister-[version]-jar-with-dependencies.jar +``` \ No newline at end of file diff --git a/src/docs/development/library_reader.md b/src/docs/development/library_reader.md new file mode 100644 index 0000000..c5ed7f2 --- /dev/null +++ b/src/docs/development/library_reader.md @@ -0,0 +1,47 @@ +# Introduction + +PDF-Reader is a small web application listing PDF documents and allowing to visualize them. + + +## Building + +This project is built using [Bower](http://bower.io). +Just install it and run : + +``` +bower install +``` + + +## How it works + +Written in AngularJS, PDF-Reader calls a resource (_/data/documents.json_) providing a list of documents such as : + +``` +[{"title": "My report", "link": "report.pdf"}] +``` + +The list is rendering such as a paginated table with a quick filter input. Clicking on the _View_ button load the document in the right side pane. + +Documents are stored in a _documents_ folder. + + +## Built with + +* UI : [Bulma](https://bulma.io) +* MVC : [AngularJS](https://angularjs.org/) +* PDF Reader : [angular-pdf](http://github.com/sayanee/angularjs-pdf) +* Pagination : [angularUtils](https://github.com/michaelbromley/angularUtils.git) +* Icons : [Font Awesome](http://fontawesome.io) + +## Licence : + +Source code is under [MIT Licence](http://opensource.org/licenses/mit-license.php) + + + + + Fork me on GitHub + \ No newline at end of file diff --git a/src/docs/index.md b/src/docs/index.md index 2b82064..f8bf87f 100644 --- a/src/docs/index.md +++ b/src/docs/index.md @@ -9,12 +9,15 @@ Different projects for different needs : - Java + [Scrabble resolver](/development/scrabble_resolver) + [Springboot / React / Webpack](/development/springboot_react_webpack) + + [Small projects](/development/java_small_projects) - NodeJS + [CloudBudget](/development/cloudbudget) (Express) + [Project deployer](/development/project_deployer) (Meteor) - Client-side + [CloudBudget-AngularJS](/development/cloudbudget_angularjs) (Express / AngularJS) + [Durandal filebrowser widget](/development/filebrowser_durandal_widget) (DurandalJS) + + [Durandal filebrowser widget](/development/filebrowser_durandal_widget) (DurandalJS) + + [Library reader](/development/library_reader) (AngularJS) * Docker - Fullstack servers + [Log centralizer](/docker/docker_log_centralizer) ELK stack with Kafka