Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bella-tassone authored Oct 18, 2023
1 parent f6bfc49 commit 8d546dd
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,18 @@ What is LoveNotes❤️🎵?\
LoveNotes is a platform that allows users to share, rate, and discover new music. After creating an account, LoveNotes users can display their favorite songs on their profile for everyone to see, and rate tracks to share their music taste. Users can also search for their friends' accounts and discover just how similar their music taste is. More coming soon, stay tuned!🚀

Noteworthy Files🛠️:\
Public: folder of dependencies (just photos currently)\
index.html: HTML code for LoveNotes' landing page. This is the page users are greeted with upon visiting the website.\
Login.html: HTML code for LoveNotes' account page. This page will likely be dynamic and will show different content based on whether or not a user is logged into their account or not.\
Style.css: CSS code used to style the landing page (index.html), including the background colors, fonts, font sizes, and overall aesthetic.\
Registration.php & Login.php: HTML and PHP code displaying the login system and establishing a functioning connection to the "users" database.\
Ratings.php: Displays all of the ratings given on LoveNotes from all users in an HTML body. Users are able to view all ratings, and edit/delete their own ratings on this page through PHP code establishing and editing the ratings database.\
Addrating.php, Updaterating.php, Deleterating.php, Viewrating.php: Accessable from the ratings page, these enable users to actually edit, delete, and view their own ratings as they are displayed in HTML and establish connections to the users and ratings databases with PHP.


**NOTE**: The sign-up and login buttons do not currently have any functionality (to be developed as project progresses).
**Images**: folder of website images\
**Index.html**: HTML code for LoveNotes' landing page. This is the page users are greeted with upon visiting the website.\
**Login.php**: The login page of our website.\
**Logout.php**: Confirms that a user wants to log out. If yes, ends the current session and user is redirected to landing page.
**Style.css**: CSS code used to style the landing page (index.html), including the background colors, fonts, font sizes, and overall aesthetic.\
**Registration.php**: The registration page of our website. Users choose a username and password that is stored securely in our backend.\
**Ratings.php**: Home page, displays all of the ratings given on LoveNotes from all users in an HTML body. Users are able to view all ratings, and edit/delete their own ratings on this page through PHP code establishing and editing the ratings database.\
**Addrating.php, Updaterating.php, Deleterating.php**: Accessible from the ratings page, these enable users to actually add, edit, and delete, their own ratings as they are displayed in HTML and establish connections to the users and ratings databases with PHP.\
**Viewrating.php**: Allows users to look specifically at any given rating shown on ratings.php.

How To Run💻:\
Currently, LoveNotes is not hosted on the internet. Thus, the code will have to be run locally in browser for the time being. This can be accomplished by going to the **Deployments** page and visiting our site from there, or alternatively just follow [this link](https://natelevinson10.github.io/COMP333_Project/).
Our website is currently deployed [here](https://lovenotes.great-site.net/?i=1), but InfinityFree is currently having [issues](https://forum.infinityfree.net/t/php-session-variable-not-carried-through-pages/84536) with maintaining php session variables, so any functionality of the site directly related to whether a user is logged in or not may not be currently working as intended. You can avoid these problems by cloning the repo and running the code locally with XAMPP.

Development Environment🛠️:\
<img width="1440" alt="Screenshot 2023-10-17 at 4 27 06 PM" src="https://github.com/natelevinson10/COMP333_Project/assets/78764811/a990bbb6-5360-4c51-ba5c-0f785a8acdd3">
Expand All @@ -30,4 +29,4 @@ HW1 participation📝: 50/50 split\
HW2 participation📝: 50/50 split


**NOTE**: Bella's local git config wasn't synced up with her github account, and this was only noticed halfway through the project. As a result, the contributions look a little funky. If you look at the commits individually then everything is correct, but in the summaries (Pulse tab) it shows her total commits as two separate users, and additionally the Contributors tab doesn't show any of the commits that she made before syncing her local git config up to her github account.
**NOTE**: In our updating ratings page, users are only allowed to change the rating of any given entry (not song or artist). This is what made most sense to us, as a user should never need to edit a song and artist, considering they already have the ability to add new entries and delete current ones. We talked to Sebastian about this and got the OK to go ahead with it!

0 comments on commit 8d546dd

Please sign in to comment.