Skip to content

tera-si/NoteSets

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

NoteSets

logo of NoteSets

Simple note-taking desktop application that allows text formatting, grouping of notes into different note sets, saving and loading note sets, and the exporting of notes as .html files.

It is submitted as my CS50x 2021 Final Project.

Screenshot

Image of NoteSets

Video Demo

Link to a video demo that demonstrates some of NoteSets' features.

Technologies

  • Java 11+
  • JavaFX / OpenJFX 11+
  • Jsoup

Launch

1. Launching from source files

Java and JavaFX runtime required on your local machine. Run app.MainApp. You'll need to add the below vm-args when running the project

--module-path %PATH_TO_FX% --add-modules
javafx.controls,javafx.fxml,javafx.web

2. Launching from Jar file

Java and JavaFX runtime required on your local machine. Download release\NoteSets.jar and run it from command line with

$ java --module-path %PATH_TO_FX% --add-modules
javafx.controls,javafx.fxml,javafx.web -jar --enable-preview NoteSets.jar

3. Install self-contained executable

Currently only for Windows. Includes bundled runtime images of Java and JavaFX, thus no Java nor JavaFX runtime required on your local machine. Download and unzip release\Win-Installer-1-0.zip, Win-Installer-1-0.z01 and Win-Installer-1-0.z02. Then use Win-Installer-1-0.exe to install NoteSets and its required runtime to your local machine. It will be installed to C:\Program Files\NoteSets. Desktop and start menu shortcuts also automatically generated upon install.

Features

  • Group or categorize notes together by creating different note sets.
  • Text formatting available (e.g. Bold, italics, indentation, lists, color).
  • Save note set as .noteset files
  • Load existing .noteset files
  • Export selected notes as .html files for portability or web uses.
  • Export the whole note set as a .zip file consisting of all the notes as .html files.
  • Reminder to save file before creating new empty note set, loading another set, or closing the application, to prevent data loss.
  • Application title bar is also a status bar, providing quick reference to the current status of the current note set.

Tutorial

The tutorial walks you through the various features and uses of NoteSets.

The very same tutorial is also embedded in NoteSets itself, simply select Tutorial from the Help menu when NoteSets is running.

TO-DO

  • Add .noteset file association

FAQ

Can I use NoteSets as an WYSIWYG html editor?

NoteSets use JavaFX's built in HTMLEditor component as a text editor, so in theory you can use NoteSets to build websites. But it is not the recommended use of NoteSets, since the HTMLEditor is too barebone for web development, you can't even create hyperlinks with it, for example.

About

My final project for CS50x. A note taking desktop application using Java and JavaFX.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published