To run the application write the following command.
./gradlew run
To run the tests write with the following command.
./gradlew test
To run the checkstyles write the following command.
./gradlew checkstyleMain
To run the jacoco report write the following command.
./gradlew jacocoTestReport
BestReads is designed for storing and searching reading tips. The Java based program is used via terminal. Tips are stored into a database (SQLite). Tips can be exported and imported.
- User can add a reading tip with a title, an url and related tags (write command "1")
- User can list all the tips she has added (write command "2")
- User can delete a tip by giving the id (write command "3")
- User can fuzzy search tips by title (write command "4")
- User can search tips by a tag (write command "5")
- User can export tips to a json file (write command "6")
- User can import tips to a json file (write command "7")
- User can exit the program (write command "0")
- The acceptance criteria of the user story are met.
- The functionality has been designed to be a logical part of the software.
- Tests for the new functionality have been written.
- Unit tests and integration tests have been passed.
- Code coverage of tests is at least 85 %.
- The new functionality has been manually tested by the programmer.
- The functionality has been documented.
- JavaDoc
- Significant new functionality should be documented in README
- Changes have been pushed to GitHub.
