Bookmarks Database

A student project done in a team of 3 members

Travis CI	Codecov	Codacy

Introduction

Bookmarks Database is a simple app for creating, editing and viewing different types of bookmarks. It's a console-based Java application, built using Gradle. It is tested with JUnit and Cucumber. Code coverage is done by Codecov and JaCoCo. Code style enforcement is by Checkstyle.

Instructions

Clone or download this repository to your computer. Unzip the archive into a folder of your choosing.

To run Bookmarks Database, simple type in gradle run. This will download all required dependencies.

Once the app starts, you'll either need to log in or register. After you have logged in with an account, you'll be presented with a list of commands. Currently, these commands are available:

	What will happen
A	begins adding a new bookmark to the database by asking for the bookmark's type and information
L	lists all of your bookmarks currently in the database (either by ID or by title)
S	searches for your bookmarks (either by title or by URL)
D	delete your existing bookmark
M	modify your existing bookmark's information
X	lists all of the commands available to the you
E	exits from the app (also logs you out)

Starting application from a jar file

• If you have cloned our project, open your command console in the root folder of the loaded project and give the command gradle jar or ./gradlew jar if using Windows. This creates the jar file that is now accessable by giving the command java -jar build/libs/ohtu.jar in the same root file.
• If you have loaded our application as a jar from a release we have made, open your command console in the folder where the loaded jar file is located and give the command java -jar ohtu.jar. Starting the application in this way will also create the database bookmarks.db needed by the application in the same folder that the jar file is located at, if there is none already in existence.

Links

Tests:

• Cucumber features

From our wiki:

• Definition of Done
• Code Style
• Database
• Sprint Charts
• Course & Miniproject Report

Backlogs (GitHub Projects):

• Product Backlog
• Sprint 1 Backlog
• Sprint 2 Backlog
• Sprint 3 Backlog
• Sprint 4 Backlog

External resources:

• Travis (continuous integration & tests)
• Codecov (test coverage)
• Codacy (static code analysis)

Commands

What	Command	Explanation
Launch this app	gradle run	Gradle will build the app first if necessary
Start the build process	gradle build	All dependencies will be downloaded
Build a JAR file	gradle jar	Cannot build if project contains errors (use check first)
Clean the project	gradle clean	Sometimes this may fix errors
Runs all checks	gradle check	This includes checking for errors and for code style violations
Run Checkstyle	gradle checkstyleMain	Checks for code style violations
Generate JaCoCo	gradle jacocoTestReport	Generates a JaCoCo (code coverage) report