- Iguehi Akhimien - GitHub username: iguehi.akhimien
- Jenna Zhang - GitHub username: stickycorner
- Prisha Patel - GitHub username: PrishaPatel24
- Liza Kochel - GitHub username: lizakochel
This project focuses on building a productivity app that allows the user to take notes, make a checklist list, and add events to their calendar. This project was made to serve students, working professionals or anyone who want to better manage life. Life can be hectic. Our goal is to create peace for the user, allowing them to manage life from one point. From the onset of the project, the vision was to find a way to make a student's productivity convenient and all in one place. So, the authors of the project created a "one-stop" life-management dashboard.
- As a user, you can create a note within the program (although not save it permanently) to probably note down things you do not want to forget. To help you, we have included a couple of features, such as translating text to a preferred language and completing your notes using Artificial Intelligence.
- As a user, you can also make a checklist of all your important tasks or things you do not want to procrastinate. To keep track of things, you can tick off tasks as you go about completing them.
- As a user, you can see your upcoming events at a view while planning to complete your tasks on your checklist or when you are planning time to revisit what you noted down.
ZenTask brings everything together!
- Features of the Software (Jump to Features of the Software)
- Installation Instructions (Jump to Installation Instructions)
- Usage Guide (Jump to Usage Guide)
- License (Jump to License)
- Feedback (Jump to Feedback)
- Contributions (Jump to Contributions)
There are three major components of this software: Calendar, Checklist and Notes. So, upon running the program, the user first sees "Welcome to your Dashboard"
On the left of the Dashboard, the user sees three tabs: Calendar, Notes and Checklist.
The user can easily migrate to the Calendar tab by clicking on it.
Now, the user is on the Calendar tab. They are prompter to log in their Google Account.
This displays the upcoming events the user has added in on their Google calendar. The details displayed are the event summary, location, start time, and description.
Note regarding Calendar Usage: Since we are unable to release our private project credentials, you should add your own service account credentials in a json file somewhere in the project and add the path to the file in the CalendarRequest section. Change the SERVICE_ACCOUNT_KEY_FILE attribute to the path and the calendar should be properly integrated to use your new own Google project credentials.
The user can also go to the Notes tab by clicking the menu on the left of their view.
Now, the user is on the Notes tab. On the left side of the user's view, they can create a new note by simply typing into the provided area.
The user also has the option of uploading text from an already existing file.
As additional functionalities, the user can translate existing text on their notes to either French, Spanish, Russian. Also, the user can prompt AI to complete the note based on what the user has written.
The user can move to the Checklist tab by clicking the menu on the left of their view.
Now, the user is on the Checklist tab. On the user's view, the user will see add task.
This will allow the user to make a new checklist or add new tasks to an already existing checklist.
Note: the program can be run on any operating systems. As the user, you should ensure that their IDE is working and already setup. If you need any help setting up, visit here. The program can be run on any OS. To run the program, there are two options:
- Through the IDE:
- First, you have to clone the repo, by using this URL.
- Then, run the MainNoteApplication found in the src/main/java/app of the project through the IDE.
- Through the terminal:
- First, you have to clone the repo, by using this URL.
- Navigate to the directory where the MainNoteApplication is on, in your File Manager (ensure the directory is like .../ZenTask/src/main/java/app).
- Then, open the terminal there.
- In you terminal, compile the program by using
javac MainNoteApplication.java - Then, run the application, using
java MainNoteApplication - You should see your Dashboard.
To use the software, the user should navigate the tabs using the menu found on the left of the view.
To view the License consistent with the details and use of this program, please refer to the file name LICENSE in the project directory.
As a user, you can give feedback on the software, using this link. Please, take your time to carefully fill out the form and should expect a follow-up with 2-3 business days.
All contributions to the project are welcome. To contribute to the project, you have to follow these steps:
- Make a fork of the project on GitHub by right-clicking Fork found on the top right of the GitHub page. Then, create a new fork.
-
Then, clone the repo and work from your IDE.
-
Do not forget to add a branch protection rule, especially if you are working with other people. Ensure everyone has their branch. Then, they will need to make a pull request on your own fork of the repository (do this through the IDE), explaining in detail what changes they have made, and perform a code review.
-
To add your contributions to this project, you have to make a merge request.
-
To make a merge request, first navigate to the back to this project's repository.
-
Then, on top of the GitHub page, click on Pull Requests.
-
Click on the green button on the left of the GitHub page to create a New pull request.
-
Then, set the base repository to this project's repository and set base to main.
-
Similarly, set the head repository to be your fork of the repository and set base to main.
-
Then, click on the green button, Create pull request.
-
In the pull request, add a title that properly summarizes the content of the "contribution". Also, add a proper description that contain what changes you made or things you added, what files your worked on and why this contribution is meaningful and beneficial.
