Giter VIP home page Giter VIP logo

ip's Introduction

BauBauBot

BauBauBot is a Java-based chatbot that helps you keep track of your to-dos, deadlines, and events. With BauBauBot, you can easily manage your tasks and stay organized. ๐Ÿค–

User Guide

You can access the user guide here!

Getting Started

To use BauBauBot, follow these simple steps:

  1. Download the JAR File: You can download the JAR file for BauBauBot from the latest releases from here.

  2. Run the JAR File: After downloading the JAR file, open your command terminal and navigate to the directory where the JAR file is located. Use the following command to run BauBauBot:

    java -jar taskbot.jar
    

    This will launch BauBauBot, and you can start interacting with it right away. ๐Ÿš€

Commands

BauBauBot understands a variety of commands to help you manage your tasks. Here are some of the key commands:

  • ๐Ÿ“… Add a Deadline: You can add a deadline task using the following command or its alias:

    deadline [NAME] /by [TIME]
    

    Alias: d

  • ๐Ÿ“† Add an Event: To add an event task, use the following command or its alias:

    event [NAME] /from [START TIME] /to [END TIME]
    

    Alias: e

  • โœ… Add a To-Do: Add a simple to-do task with this command or its alias:

    todo [NAME]
    

    Alias: t

  • ๐Ÿ—‘๏ธ Delete a Task: Remove a task from your list using this command or its alias:

    delete [TASK NUMBER]
    

    Alias: rm

  • ๐Ÿ” Find Tasks: To search for tasks that match a partial search term in their names, use this command or its alias:

    find [PARTIAL SEARCH TERM]
    

    Alias: f

  • ๐Ÿ“‹ List Tasks: View all your tasks with this command or its alias:

    list
    

    Alias: ls

  • โœ… Mark Task as Done: Mark a task as completed with this command or its alias:

    mark [TASK NUMBER]
    

    Alias: m

  • โŒ Mark Task as Undone: Reverse a completed task to its undone status with this command or its alias:

    unmark [TASK NUMBER]
    

    Alias: um

Development

If you're interested in contributing to BauBauBot or exploring its code, here's how you can get started:

  • Clone the Repository: You can clone the BauBauBot repository from GitHub using the following command:

    git clone https://github.com/et-irl/ip.git
    
  • Install Java 11: Ensure that you have Java 11 or higher installed on your system. You can download Java 11 for Windows or Linux from the official Oracle website or use your preferred package manager. โ˜•

  • Build and Run: Use the following Gradle commands to build, run, clean, and test the project:

    • To build the project:

      ./gradlew build
      
    • To run the project:

      ./gradlew run
      
    • To clean the project:

      ./gradlew clean
      
    • To run tests:

      ./gradlew test
      

We welcome pull requests and issue reports from the community. Feel free to contribute and help improve BauBauBot. ๐Ÿ™Œ

ip's People

Contributors

damithc avatar eclipse-dominator avatar j-lum avatar jiachen247 avatar lunaflight avatar seanleong339 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

ip's Issues

Sharing iP code quality feedback [for @et-irl]

@et-irl 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 @et-irl] - Round 2

@et-irl 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.