Git Product home page Git Product logo

java-todo-app's Introduction

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)

java-todo-app's People

Contributors

theithorian avatar

Watchers

 avatar

java-todo-app's Issues

Save user configuration to file

Accept a configuration flag which will allow the user to save their information:

  • username
  • password

Save the config to a file.

Add command line application interface

Add cli functionality to walk the user through processing records

  • Single command to run the application
  • Greeted with list of options:
    • Add new todo
      • Prompt for title and description
    • See all todo
    • Search toto
    • Update user info
    • Logout / Login

Read todo items

Print a list of all the todo items, with an option to filter by title.

todo --list --search <title>

The id, title, and description should be printed to the console.

Add a todo item and store to system

Add command to add a new todo record, which is linked to the current user by the username.

todo -a <todo_name> -d <todo_description>

Each todo record should have the following properties:

  • id
  • title
  • description
  • username

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.