wxiaoyun / ip Goto Github PK

This project forked from nus-cs2103-ay2324s2/ip

Shell 10.48% Java 89.52%

ip's Introduction

It's Duking Time

“Any fool can write code that a computer can understand. Good programmers write code that humans can understand.” – Martin Fowler

Duking Time lets you duke whenever you want, wherever you can run java. It is:

Not scalable
Offline only
Not easy to use

Prerequisites:

Familiarity with command line
Familiarity with Java, a high level, garbage collected, statically typed, compiled and interpreted, object oriented, perfect programming language

Features:

Blazingly fast 🦀 (not possible unless you use ruby, python or javascript)
Add and keep track of your tasks, except occasionally making you yell when missing a "/" in the command
Easily see all of your tasks by dumping all of your tasks at once instead of pagination
Very intuitive marking/deletion of tasks by ids instead of task details
Persistent storage of your tasks in a offline app that probably only runs on your pc instead of putting it in a cloud based cross-platform service that syncs your tasks across all of your devices
Very robust app with 0.1% test coverage
Impressive GUI that uses JavaFX instead modern web frameworks such as svelte

It is free!

Except it is a waste of your time to use it

How to Use

To get started with our application, follow these simple steps:

Clone the repository:

git clone https://github.com/ForAeons/ip.git

Navigate to the project directory:

cd ip

Build the app:

./gradlew build

Start the application or run the main method of the Main class:

./gradlew run

ip's People

Contributors

ip's Issues

Sharing iP code quality feedback [for @ForAeons] - Round 2

@ForAeons We did an automated analysis of your code to detect potential areas to improve the code quality. The script did not detect any issues in your code (nice!).

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only i.e., there can be other areas/places to improve.

Aspect: Tab Usage

No easy-to-detect issues 👍

Aspect: Naming boolean variables/methods

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

No easy-to-detect issues 👍

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

No easy-to-detect issues 👍

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

No easy-to-detect issues 👍

Aspect: Recent Git Commit Message

No easy-to-detect issues 👍

Aspect: Binary files in repo

No easy-to-detect issues 👍

ℹ️ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact [email protected] if you want to follow up on this post.

Sharing iP code quality feedback [for @ForAeons]

@ForAeons We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, to help you improve the iP code further.

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.

Aspect: Tab Usage

No easy-to-detect issues 👍

Aspect: Naming boolean variables/methods

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

No easy-to-detect issues 👍

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

No easy-to-detect issues 👍

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/database/Database.java lines 17-22:

    /**
     * Connect to the database.
     *
     * @throws SQLException
     *             if a database error occurs
     */

Example from src/main/java/database/Database.java lines 38-43:

    /**
     * Disconnect from the database.
     *
     * @throws SQLException
     *             if a database error occurs
     */

Example from src/main/java/database/Database.java lines 48-57:

    /**
     * Execute a SQL statement.
     *
     * @param sql
     *            the SQL statement to execute
     * @return a ResultSet object that contains the data produced by the given
     *         query.
     * @throws SQLException
     *             if a database error occurs
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

Aspect: Recent Git Commit Message

possible problems in commit a5426f5:


Add help command
* Add explain abstract method to Command class
* Help command calls explain on the corresponding command

No blank line between subject and body

Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).

Aspect: Binary files in repo

No easy-to-detect issues 👍

wxiaoyun / ip Goto Github PK

ip's Introduction

It's Duking Time

Duking Time lets you duke whenever you want, wherever you can run java. It is:

Prerequisites:

Features:

It is free!

How to Use

ip's People

Contributors

ip's Issues

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Class size

Aspect: Header Comments

Aspect: Recent Git Commit Message

Aspect: Binary files in repo

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Class size

Aspect: Header Comments

Aspect: Recent Git Commit Message

Aspect: Binary files in repo

Recommend Projects

Recommend Topics

Recommend Org