Quotesify

Quotesify is a free greenfield Java project by a team of software engineering students.

Are you constantly reading books and browsing articles on the web only to forget most of it in a short period of time?

If so Quotesify is for you! A minimal distraction free CLI that helps you manage the information you consume by tracking the things you read and logging those important nuggets of wisdom you find along the way!

With Quotesify, users can add books and quotes that they wish to remember. They can categorize their books and quotes by author, customized categories, and even rate their books. Quotesify also comes with a progress tracker just to improve the reading experience of users.

Interested to contribute to the development of Quotesify? Given below are instructions on how to use it.

Setting up in IntelliJ

1. Fork the Quotesify repo from here, and clone the fork to your computer.
2. Open up your IDE (IntelliJ is highly recommended). If you are not at the welcome screen, click File > Close Project to close any existing project.
3. Set up the correct JDK version for Gradle:
   1. Click Configure > Project Defaults > Project Structure.
   2. Click New… and find the directory where you saved your JDK.
4. Click Import Project.
5. Locate the build.gradle file and select it.
6. Click OK.
7. Click Open as Project.
8. Click OK to accept all default settings.
9. To verify the set up, locate the Quotesify.java file, right-click it and select Run Quotesify.main(). If the setup is correct, you should see something like this as shown below:

> Task :compileJava UP-TO-DATE
> Task :processResources NO-SOURCE
> Task :classes UP-TO-DATE

> Task :Quotesify.main()
________                __                .__  _____       
\_____  \  __ __  _____/  |_  ____   _____|__|/ ____\__.__.
 /  / \  \|  |  \/  _ \   __\/ __ \ /  ___/  \   __<   |  |
/   \_/.  \  |  (  <_> )  | \  ___/ \___ \|  ||  |  \___  |
\_____\ \_/____/ \____/|__|  \___  >____  >__||__|  / ____|
       \__>                      \/     \/          \/    
Welcome to Quotesify v2.1!
Before you continue, here's something:
Better days are coming, they are called Saturday and Sunday.
---------------------------------------------------------------

What would you like to do with Quotesify?

Documentation

Documentation for Quotesify including User and Developer Guide is stored in /docs directory.

Click here to access the documentation such as User Guide and Developer Guide.

Testing

I/O redirection tests

• To execute I/O redirection tests:

  1. Navigate to the text-ui-test directory.
  2. Enter the input commands into the INPUT.TXT file.
  3. Run the runtest(.bat/.sh).

• A comparison will be done between EXPECTED.TXT and ACTUAL.TXT

JUnit Tests

• JUnit tests are stored in the src/test/java directory.
• If you are new to JUnit, please refer to the JUnit Tutorial at se-education.org/guides.

Checkstyle

• CheckStyle rule is configured in this project.
• If you are new to Checkstyle, please refer to the Checkstyle Tutorial at se-education.org/guides.

Build automation using Gradle

• This project uses Gradle for build automation and dependency management.
• If you are new to Gradle, please refer to the Gradle Tutorial at se-education.org/guides.

CI using GitHub Actions

The project uses GitHub actions for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR.

Acknowledgements

• JSON.simple was used for the parsing of JSON formatted strings for data storage.