/Java-Todo-App

Simple cli to-do app written in Java

Primary LanguageJavaMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License

Java To-do App

A simple command line interface for a to-do app, made to explore writing Java
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

I have some experience with Apex but I wanted to explore Java so I wrote a simple command line interface for a to-do app.

(back to top)

Built With

Java

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Installation

  1. Clone the repo 
    git clone https://github.com/TheIthorian/Java-Todo-App.git

Compiling

Compile classes

mvn compile

Create Todo.jar from class (Java Archive)

mvn clean package
# Or to include dependencies:
mvn assembly:assembly -DdescriptorId=jar-with-dependencies

Run .jar

java -jar target/todo-0.0.1.jar Todo

Read more here https://www.cs.odu.edu/~zeil/cs382/latest/Public/runAnywhere/index.html

(back to top)

Usage

  • Set your username and password

    java -jar todo-0.0.1.jar -cf -username=<my_username> -password=<my_password>

  • Add the user

    java -jar todo-0.0.1.jar -addUser

  • Add a todo item

    java -jar todo-0.0.1.jar -a title="Some title" description="some description"

  • Get all items

    java -jar todo-0.0.1.jar -g

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Link to Google Calendar

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/TheIthorian/Java-Todo-App

(back to top)