timhyc19 / NotesApp

Develop a standalone application designed for recording, searching, and deleting short, adhoc notes.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Notes Application

Goal

Develop a standalone application designed for recording, searching, and deleting short, adhoc notes.

Team Members

Yang Ji, John Chung, Hammad Khan, Tim Chung

Quick-start

Windows:

  1. Download the connectnotesinstance.pem file from GitLab EC2Key folder.
  2. SSH into AWS EC2 server instance with the following commands:
    ssh -i <Path-To-connectnotesinstance.pem> ec2-user@ec2-54-80-234-31.compute-1.amazonaws.com
  3. Start the Spring Server by running java -jar demo-0.0.1-SNAPSHOT.jar
  4. Download the application from the installer in GitLab releases folder, and run the application!.
  5. The application can also be ran through the console, by calling Notes.sh

MacOS (Similar to above with additional steps):

  1. Download the connectnotesinstance.pem file from GitLab EC2Key folder.
  2. Change owner file permissions of the .pem file by running sudo chown <User-Name> <Path-To-connectnotesinstance.pem>
  3. Allow user, group, and other permissions by running chmod 400 <Path-To-connectnotesinstance.pem>
  4. Follow steps 2-5 above!

You can also find a usage page under https://git.uwaterloo.ca/j88chung1/cs346-project/-/wikis/Notes-App-Usage/Features with implemented features and what our app can do!

Releases

Version 1.0: Released Feburary 17th, 2023
- release-notes (in releases folder)
- Installers (Windows, MacOS)

Version 2.0: Released March 10th, 2023
- release-notes (in releases folder)
- Installers (Windows, MacOS)

Version 3.0: Released March 24th, 2023
- release-notes (in releases folder)
- Installers (Windows, MacOS)

Version 3.0: Released April 10th, 2023
- release-notes (in releases folder)
- Installers (Windows, MacOS)

Supported gradle tasks:

Tasks Description
clean Remove build/ directory
build Build the application project in build/ directory
run Run the application or console project
distZip Create run scripts in application/build/distribution
distTar Create run scripts in application/build/distribution

About

Develop a standalone application designed for recording, searching, and deleting short, adhoc notes.


Languages

Language:Kotlin 99.1%Language:Java 0.9%Language:Shell 0.0%