Skip to content

Repository files navigation

EZ Notes

EZ Notes Logo

2020-2021 TSA Software Development project

Setup

Input these commands into the command prompt to get an executable jar file (.jar) to run the main class in Window.java:

cd EZ-Notes
javac -d build *.java 
jar -cmf manifest.mf build/window.jar -C build .
java -jar build/window.jar
  1. Navigate to your project folder
  2. Compile .class files into build/
  3. Create the JAR file from the classes in build/
  4. Run the JAR file

If any errors result from these commands, compile and run Window.java in a separate IDE.

Topics

1. Login System

Upon start up, you will have two options when it comes to account management, "Login" and "Register". Our registration system will require basic personal information along with a username and a password. To login and have access to your saved notes, simply type both the username and password associated with your account into the corresponding data fields.

2. Menu Interface

Upon entry of the application, you will be greeted with recent saves, files, notebooks, and menu screen. You can reopen any of these saved documents, and begin working within them. Learn more about this feature in the title below.

3. Creating your first Notebook and Notes

Creating your first Notebook is simple, first understand a Notebook is a collection of Note documents, to create a singular sheet click, "Add Page". To create a Notebook click, "Add Notebook". To insert a new page into a notebook, select the Notebook that you have created and then follow the procedure for adding a singular sheet. To expand a Notebook and see all of the contents bound to that directory, press it again to collapse. To unopen all documents selected, click the "Refresh" bar to reload all saved data entries. To delete a file simply select the object, click "Delete", and a window will appear asking if it is okay to delete the object.

4. Citation Support

Inside of your notebook, click "Add citations" (Note, all citations are in the MLA format and our application is only equppied with the utilities for formating websites. You will be prompted to enter in site information, please enter in all applicable information that you have up to date on sources.

5. Economy System

Our economy system is based off time, you can enable earnings by entering focus mode inside of a notes document, more on focus mode below. Every second that passes in real time equivaltes to one credit. You can spend these credits within the shop interface of the garden which will be explained in more detail below.

6. Starting your garden

Upon entry, you will be granted a level one tree, and the starter environment. You can upgrade these as time goes on, and your credit amount increases. As you progress, you can level up founded landmarks which gives the artificats more growth and texture. To purchase items, simply click on the prompted button and the amount will be reduced from your credit balance.

7. Modes

Our app offers a few modes for different note-taking expereiences:

  • Standard: No music, no economic features, just you, your notes, and a quiet space.
  • Zen: Standard mode with a cyclical playlist of tracks created to soothe the mind and influence productivity.
  • Focus: Standard mode with the exception of the ability to earn credits to spend in the shop

References

Java Swing:

https://docs.oracle.com/javase/tutorial/uiswing/components/index.html https://docs.oracle.com/javase/7/docs/api/javax/swing/package-summary.html https://docs.oracle.com/javase/tutorial/uiswing/layout/card.html

Netbeans:

https://netbeans.org/kb/trails/matisse.html

File Management:

https://stackoverflow.com/questions/6366743/saving-files-to-a-specific-directory-in-java https://stackoverflow.com/questions/4917326/how-to-iterate-over-the-files-of-a-certain-directory-in-java https://stackoverflow.com/questions/20039980/java-replace-line-in-text-file

Interactives:

https://www.codejava.net/coding/how-to-play-back-audio-in-java-with-examples

Music:

https://www.youtube.com/watch?v=ws8ofAF0Gxk https://www.youtube.com/watch?v=gUcQVC8De1o&t=1435s

Jar and Exe Files:

https://www.stackoverflow.com/questions/804466/how-do-i-create-executable-java-program

About

Interactive note-taking app with personalization settings and credits system for redeeming rewards

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages