gotonode / snippets

Snippets - a simple code snippet manager (student project)

Snippets

Snippets - a simple code snippet manager (student project)

Travis CI	Codecov

A code snippet manager built with Java and tested with JUnit. GUI by JavaFX. Database functionality by SQLite. Code coverage by JaCoCo. Style enforcement by Checkstyle. Documentation by JavaDoc.

IDE used is JetBrains IntelliJ IDEA Professional.

How to run

Download a release here.

Double-click the downloaded JAR -file. If that doesn't work, use this command:

java -jar Snippets.jar

Documentation

• Manual
• Software requirements
• Architecture
• Testing
• Hours spent on project

Commands

Before you start:

1. Please make sure that your OS properly detects Java
2. Maven must be installed also, and your OS must be able to find it
3. Build the project (see instructions below)

Building the project

This will also generate a runnable JAR -file.

mvn clean package

The optional clean argument ensures no collisions happen with existing files, but building will take a bit longer.

Output: "target/snippets-1.0.jar" (do not open the one that says "original" in it)

Tests

JUnit tests

mvn test

Output: (will be printed to console)

Code-coverage report with JaCoCo

mvn jacoco:report

Output: "target/site/jacoco/index.html"

Generate JavaDoc

JavaDoc has been written for all publicly-visible members.

mvn javadoc:javadoc

Output: "target/site/apidocs/index.html"

Generate Checkstyle

Checkstyle checks can be manually created with this command:

mvn jxr:jxr checkstyle:checkstyle

Output: "target/site/checkstyle.xml"