diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..ea7ed09 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,5 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/.idea/Lunch_Buddies.iml b/.idea/Lunch_Buddies.iml new file mode 100644 index 0000000..0b872d8 --- /dev/null +++ b/.idea/Lunch_Buddies.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..85d1e04 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..c8397c9 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index daad3ff..b338239 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,42 @@ # WELCOME TO LUNCH BUDDIES!!! -### _An application that lets you find and match with like-minded students on campus to study, have a meal with, and more!_ ---- +## Connect. Eat Lunch. Make Friends. + # Table of Contents -1. [Install](#install) -2. [Usage](#usage) -3. [Debugging](#debugging) -4. [Contributing](#contributing) +1[Description](#description) +2[Install](#install) +3[Usage](#usage) +4[Debugging](#debugging) +5[Contributing](#contributing) - [Front End](#front-end) - [Tips](#tips) +6[License](#license) --- +## Description +Are you a university student looking to expand your social circle, network with like-minded individuals, or simply make new friends over a meal? Look no further than Lunch Buddies, the ultimate app designed to bring students together over lunchtime. + +Lunch Buddies is more than just a lunch meetup app; it's a platform for forging meaningful connections, whether you're pursuing your academic dreams, exploring new career paths, or seeking lifelong friendships. + +Key Features: +Discover Lunch Partners: Browse through profiles of fellow students from various fields of study and interests. +Schedule Lunches: Arrange meetups at your convenience, allowing you to make the most of your break time. +Expand Your Network: Connect with individuals in your field of study, fostering opportunities for future collaborations and mentorships. +Enhanced Social Experience: Share your interests, hobbies, and career aspirations to find like-minded individuals. +Safe and Secure: Your privacy and safety are our top priorities. Enjoy a secure environment for making connections. +How It Works: +Create Your Profile: Sign up and build a personal profile highlighting your interests, major, and availability. +Find Lunch Partners: Browse profiles and connect with students who share your interests or career goals. +Schedule a Lunch: Propose meetups and set the date, time, and location for your lunch get-togethers. +Meet and Connect: Enjoy meaningful conversations and make lasting connections with your lunch buddies. +Why Lunch Buddies? +Networking Opportunities: Expand your network and gain insights into your chosen field of study or career path. +Friendship Building: Forge friendships that extend beyond your lunch meetups. +Campus Community: Strengthen the sense of community among your fellow students. +Personal Growth: Step out of your comfort zone and enhance your social skills. +Join Lunch Buddies today and start building connections, one meal at a time. Whether you're an undergraduate, graduate student, or simply hungry for friendship, we're here to help you find your lunchtime companions. + +Get ready to connect, network, and make friends with Lunch Buddies! + ## Install - To start, clone the repository: `git clone https://github.com/ufosc/Lunch_Buddies.git` @@ -65,4 +92,205 @@ - [Expo Documentation](https://docs.expo.dev/) - [Golang Documentation](https://go.dev/doc/) - +## License + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/api/login/login.go b/api/login/login.go index 0864078..1de7a55 100644 --- a/api/login/login.go +++ b/api/login/login.go @@ -13,11 +13,13 @@ import ( "github.com/gorilla/mux" ) +// Account represents the JSON structure of an account. type Account struct { Email string `json:"email"` Password string `json:"password"` } +// createAccount handles the creation of a new user account. func createAccount(response http.ResponseWriter, request *http.Request) { log.Println("Received request to /login/createAccount") @@ -29,15 +31,18 @@ func createAccount(response http.ResponseWriter, request *http.Request) { var acc Account err := json.NewDecoder(request.Body).Decode(&acc) + // Check for JSON decoding errors or empty email. if err != nil || acc.Email == "" { return } + // Execute a database query to insert the new account. result, err := database.Execute("INSERT INTO Accounts (email, password) VALUES (?, SHA2(?, 256))", acc.Email, acc.Password) if err != nil { return } + // Check if any rows were affected by the database operation. rowsAffected, err := result.RowsAffected() if err != nil || rowsAffected == 0 { return @@ -46,6 +51,7 @@ func createAccount(response http.ResponseWriter, request *http.Request) { status = true } +// validateAccount handles the validation of user credentials and issues a JWT token on success. func validateAccount(response http.ResponseWriter, request *http.Request) { log.Println("Received request to /login/validateAccount") @@ -59,13 +65,16 @@ func validateAccount(response http.ResponseWriter, request *http.Request) { return } + // Get a JWT token for the provided email and password. token, err := auth.GetToken(acc.Email, acc.Password) + // Check for authentication errors. if err != nil { fmt.Fprint(response, FAILURE_RESPONSE) return } + // Sign the JWT token with a secret and send it in the response. tokenString, err := token.SignedString([]byte(os.Getenv("JWT_SECRET"))) if err != nil { @@ -76,6 +85,7 @@ func validateAccount(response http.ResponseWriter, request *http.Request) { fmt.Fprint(response, tokenString) } +// HandleLoginRoutes registers login-related routes with the provided router. func HandleLoginRoutes(r *mux.Router) { r.HandleFunc("/login/createAccount", createAccount).Methods("POST") r.HandleFunc("/login/validateAccount", validateAccount).Methods("POST") diff --git a/api/messages/messages.go b/api/messages/messages.go index 9b875c3..f522ec6 100644 --- a/api/messages/messages.go +++ b/api/messages/messages.go @@ -59,6 +59,7 @@ func sendMessage(sender, receiver, content string) error { return err } +// getMessagesHandler handles GET requests to retrieve messages. func getMessagesHandler(response http.ResponseWriter, request *http.Request) { log.Println("Received request to /messages/") @@ -87,6 +88,7 @@ func getMessagesHandler(response http.ResponseWriter, request *http.Request) { } } +// sendMessageHandler handles POST requests to send messages. func sendMessageHandler(response http.ResponseWriter, request *http.Request) { log.Println("Received request to /messages/sendMessage") @@ -115,6 +117,7 @@ func sendMessageHandler(response http.ResponseWriter, request *http.Request) { fmt.Fprint(response, "Message sent") } +// HandleLoginRoutes registers message-related routes with the provided router. func HandleLoginRoutes(router *mux.Router) { router.HandleFunc("/messages/", getMessagesHandler).Methods("GET") router.HandleFunc("/messages/{email}", getMessagesHandler).Methods("GET")