Merge branch 'master' of https://github.com/vicenteparmi/armarios-dq

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Vicente K. Parmigiani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,37 @@
+# Armários DQ
+
+## Overview
+Armários DQ is a web platform designed to facilitate the reservation and management of lockers at the Department of Chemistry, UFPR. Users can reserve lockers, manage their contracts, and follow the payment status through the platform.
+
+## Key Functionalities
+
+### Locker Reservation
+- **Locate Available Lockers**: Users can find lockers without padlocks at the Department of Chemistry.
+- **Reserve a Locker**: After placing a padlock on an available locker, users can reserve it through the website by filling out a form and submitting a contract request.
+
+### Contract Management
+- **Request New Contracts**: Users can request new locker contracts by providing necessary details and submitting the form.
+- **Contract Status**: Users can view the status of their contracts, including:
+  - **Regular**: The contract is valid.
+  - **Irregular**: The locker does not have a valid contract.
+  - **Aguardando pagamento**: Payment is pending.
+  - **Livre**: The locker is empty and without a contract.
+  - **Problema no cadastro**: There is an issue with the user's registration.
+  - **Não utilizável**: The locker is broken or damaged.
+
+### Payment Methods
+- **PIX**: Users can make payments via PIX by sending the locker fee to the provided email address and submitting the payment receipt.
+- **Cash**: Users can pay in cash to a CAQuí member and submit the payment receipt via email.
+
+### Problem Reporting
+- **Report Issues**: Users can report issues such as discrepancies in locker availability or incorrect contract status.
+
+## Administration
+
+The app counts with a page only for admins to approve and change all the locker's status.
+
+## Contact
+For any issues or inquiries, users can contact the platform creator, Vicente Parmigiani, through the provided [link](https://linktr.ee/vicenteparmi).
+
+## License
+This project is licensed under the MIT License.