# PuppyLove User Manual

Welcome to PuppyLove, a platform for the campus community developed by the Programming Club IIT Kanpur. This user manual will guide you through the various features and functionalities of our website.


<br>

## Getting Started

### Registration
- Click on the ``Sign Up`` button and enter your roll number here. You will receive a unique ``OTP`` in your IITK mail.


> **Note:** Registrations will close at **23:59 on 10th February**. Students who are not registered will be shown as "Not Registered" in the search tab and **cannot receive hearts**.
>
> If you encounter any issues during registration, please contact any of the developers.

### Verification
- Create your ``password`` here and verify using the ``OTP`` which you recieved on your mail id.


**Note:** DO NOT misplace your password as it will be used for the creation of your private and public keys. **Regenerating your password is not possible**.

### Login
- The page will be redirected to the login page. Log in using your ``IITK Roll Number`` and the ``password`` you have created.


**Retrieve Password** - If you forgot your password and have downloaded recovery codes by logging in before, you can recover your password by using this.
<br>

## Dashboard

You can now easily switch the background of your dashboard! Just click on the moon/stars icon at the top right, and voilà — a brand new vibe to match your mood.

### Updating About Me section
Click on the highlighted section and tell us a bit about yourself! Share what makes you unique and let others discover who you are!

### Adding Interests
Show off your personality by adding **up to 4** awesome interests that will be featured on your profile!

Click on the **+**(plus) button to add your interests. This will open a section of available tags to choose from on the right side of the screen:
To add an interest from the list, type the interest in the entry field which says 'Add new interest' and click on Add.

You can remove a tag by clicking on the old tag and pressing the cross (**x**). 

### Discover
Use the search bar on the right half of your dashboard to discover students. You can select up to 4 students to send your heart to!

**Note:** Hearts can only be sent to students who have registered.

### Recieved Hearts
Number of hearts sent to you is visible on the top of the search bar. These hearts will live-update everytime you login.

### Viewing Choices
View your choices by clicking on the Lock icon on top of the search bar. The lock ensures your choices remain discreet, even when you're using PuppyLove near someone else.🕵️‍♀️

### Sending Music
Now, you can send your favorite songs with a touch of love 🎶💘! Just tap the lock icon to reveal your selected users, then hit the music button on their profile
Pick that song that speaks your heart, and confirm your choice. Not happy with your pick? No worries! You can easily change your selection by searching for a new track.

Your song will only be revealed when you both match!

### Find Similar Users
Ready to discover new people who share your interests? Simply click the button at the bottom left of the dashboard, and let the magic happen! ✨ This feature suggests users who match your interests the best, helping you discover your perfect connections. 🧩 Click the button again to discover new people!

### Heart Submission
Click the ``Submit Hearts`` button(on bottom left) ONLY ONCE you are satisfied with your choice since edits are not permitted post-submission.

**Note:** Heart submissions will close at **23:59 on 12th February**. There is no auto submit.

### Recovery Codes
In case you forget your password, you can recover your account using Recovery Codes!
You can generate multiple recovery codes by using the button `Recovery Codes` in bottom left.
You will need to enter your password to activate the recovery code being shown in the above field, and then click on proceed.
As one recovery code will not be shown to you again, you will need to save it securely.

### Logout
You can logout using the “Log Out” button.

<br>

## Publish

### Publish Permission
- **On 13th Feb**, no further hearts can be sent. All users who want to be matched have to grant permission to publish their match.


**Explanation:** If hearts are sent mutually between two people and one of them doesn’t publish, neither of the students will see a match.

<br>

## Results
**On 14th Feb**, Login to view your match.

<!--  -->

### Matches
- Students matched with you are visible on the right section.
### Hearts
- Received hearts by girls and boys can be viewed on the left section.

<br>

## Help and Support

### Contact Support
- If you need further assistance or have any questions, feel free to contact any of our developers:
- Aman Singh Gill: [e-mail]
- Yash Pratap Singh: [e-mail]
- Aayush Anand: [e-mail]
- Manas Jain Kuniya: [e-mail]
- Medha Agarwal: [e-mail]

<br>

<br>

We hope this user manual helps you navigate through PuppyLove with ease. Happy matching!