Darker Notes

This repository contains all the pertinent information on our Markdown and LaTeX Note Editor. Our team is composed of: Alexander Gednov, Connor Buckley, Hriday Panchasara, Laurence Fong, and Tong Wu. See the appropriate documents for details on the different parts of our project.

Instructions

Set up with Eclipse

1. Open Terminal
2. Change directory to your eclipse workspace
3. Typically at cd ~/eclipse-workspace
4. Clone the repository in your eclipse workspace directory git clone [email protected]:Laurenzarus/DarkerNotes.git
5. Open Eclipse
6. Go to File -> Open Projects From File System...
7. Import source from the directory you cloned, the folder called final-project
8. Click Finish
9. success!

Database

To make development easier, change your MySQL root user password to password

Instructions if you need to change your password

1. On macOS, change directory to the MySQL command line utility
2. cd /usr/local/mysql-8.0.12-macos10.13-x86_64/bin (might be different depending on your MySQL version)
3. ./mysql -u root -p
4. Enter your current password
5. Once you are in, it should look like mysql>
6. Enter FLUSH PRIVILEGES;
7. Enter ALTER USER 'root'@'localhost' IDENTIFIED BY 'password';
8. Enter \q to exit
9. You can make sure it works by repeating steps 3 and 4 to see if you can log in successfully

reference: https://dev.mysql.com/doc/refman/8.0/en/resetting-permissions.html

Setting up the Database

Open makeDatabase.sql in the root directory of the project.

In MySQL Workbench, click the lightning button and it should create the database! You are then ready to run Tomcat and use the app.

Dependencies

Client-side

• jQuery
• Bootstrap
• Showdown, a Javascript markdown parser
• KaTeX, a fast LaTeX parser/renderer written in Javascript
  • View API here for usage

Server-side

• Java Servlets
• JDBC
• MySQL