diff options
39 files changed, 1986 insertions, 0 deletions
@@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..29eebfc --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +# TOTAL EXPENSE + +## Introduction + +This is my final project for Harvard University's online course CS50x. + +I created Total Expense in December 2021 and this repo only serves as a "historical archive". + +All code as well as the content of the Readme below are in their original state, only this introduction and the License was added. + +#### Video Demo: (https://youtu.be/gh2tL8mPyMc) +pw54fegood1 +#### Description: + +Total Expense is a web-based financial assistant. + +##### Purpose: + +The original idea was to create an app that allows users to set their individual budget, register each new expense and review past expenses. + +Later on another feature was added: a simple web scraper to search for cheap sales offers online. + +Overall the goal of the app is to provide a useful tool to anybody who wants to +- monitor their spending habits +- cut down on unnecessary or excessive expenses +- keep track of their available budget +- avoid sliding into debt +- shift the amount of money spent on a certain area towards another one +- consider buying cheaper second-hand products for the sake of saving money and sustainability + +##### Components: + +A user has to register a new account and/or log in first in order to use the app. +Once registered, users are allowed to change their passwords again in the "Account" section. + +After signing in, the user can set their budget. All expenses registered thereafter will be deducted from the budget. +However, setting a budget is optional, expenses can be submitted regardless. +In that case, the budget balance will simply show the total amount of money spent. + +To register a new expense, the user has to use a form where they can name the specific expense. +Naming the expense is optional, but the user is required to give the amount of money spent, +the date of the expense as well to choose an overall category for it. + +Once an expense is submitted, the user can review it and all previous (and following) expenses in the Spending History section. +A table displays the name of the expense ("Unspecified" if left blank by the user), category, amount and date. +The user can also use a search field combined with radio buttons to filter for something specific, +like a certain date, or to display all entries from one category, etc. +Finally, a pie chart on the main page will display the total amount of expenses in each category, +useful for comparisons between e.g. how much is spent on hobbies vs. investment. + +Last but not least, the web scraping feature called "Bargain Finder" allows the user to search for any item +and receive a list of the cheapest offers for that item on Ebay.com. +These offers are sorted by cheapest first, each offering the exact name of the offer on Ebay, +the current price and a link that takes the user directly to the respective page. + +##### The Code: + +The app relies on Python, SQL and JavaScript to run, while the view-component was styled with HTML & CSS, utilizing Jinja templates. +Essential components of the code are Flask as web framework and Beautiful Soup for the web scraping/crawling. + +Two JavaScript files handle matters of visualizing data for the user. +First, piechart.js takes care of the implementation of the pie chart, as well as dynamically +changing the background of the budget display, depending on the user going into debt or not. +Second, filter.js implements the filter-search option for the table in history.html. + +application.py contains all the main code for users registering, logging in & logging out, +passing data between the database (spending.db) and the webpage. +spending.db contains two tables, one for the users storing their username, hashed password and cash/budget. +The second table stores all expenses for each individual user. +Table data meant for display is integerated into the HTML mostly by Jinja loops. + +helpers.py contains helper functions, e.g. for rendering an apology message in case of errors +and for handling the log-in requirement for most pages. +It also contains the function for web scraping which gets called in application.py's "/bargain" route. + +##### Sources: + +Apart from the knowledge gained from CS50's lectures, shorts, labs and problem sets - especially pset9 "finance" - the following sources were used: +- Flask documentation: (https://flask.palletsprojects.com/en/2.0.x/) +- Beautiful Soup documentation: (https://www.crummy.com/software/BeautifulSoup/bs4/doc/) +- Chart.js documentation: (https://www.chartjs.org/docs/latest/) +- W3 Schools Tutorials, especially on JavaScript: (https://www.w3schools.com/js/default.asp) +- Corey Schafer's "Python Tutorial: Web Scraping with BeautifulSoup and Requests": (https://www.youtube.com/watch?v=ng2o98k983k) +- Tech with Tim's "Beautiful Soup 4 Tutorial" Playlist: (https://www.youtube.com/watch?v=gRLHr664tXA&list=PLzMcBGfZo4-lSq2IDrA6vpZEV92AmQfJK) +- Stack Overflow for reading up on smaller issues encountered here and there during coding diff --git a/application.py b/application.py new file mode 100644 index 0000000..54c7e6e --- /dev/null +++ b/application.py @@ -0,0 +1,261 @@ +import os + +from cs50 import SQL +from flask import Flask, flash, redirect, render_template, request, session +from flask_session import Session +from tempfile import mkdtemp +from werkzeug.exceptions import default_exceptions, HTTPException, InternalServerError +from werkzeug.security import check_password_hash, generate_password_hash + +from helpers import apology, deal_finder, login_required, passw_requirements, usd + +# Configure application +app = Flask(__name__) + +# Ensure templates are auto-reloaded +app.config["TEMPLATES_AUTO_RELOAD"] = True + +# Ensure responses aren't cached, allows smoother implementation of development-changes +@app.after_request +def after_request(response): + response.headers["Cache-Control"] = "no-cache, no-store, must-revalidate" + response.headers["Expires"] = 0 + response.headers["Pragma"] = "no-cache" + return response + +# Custom filter +app.jinja_env.filters["usd"] = usd + +# Configure session to use filesystem (instead of signed cookies, to avoid multiple cookies in one browser) +app.config["SESSION_FILE_DIR"] = mkdtemp() +app.config["SESSION_PERMANENT"] = False +app.config["SESSION_TYPE"] = "filesystem" +Session(app) + +# Configure the SQLite database +db = SQL("sqlite:///spending.db") + + +@app.route("/") +def home(): + """Home page with different versions for visiting guests & logged-in users """ + + # When a non-registered guest visits the website: + if not session: + return render_template("welcome.html") + + # For a logged-in user: + else: + user_id = session["user_id"] + + # Getting username & budget + user_info = db.execute("SELECT * FROM users WHERE id = ?", user_id) + username = user_info[0]["username"] + cash = user_info[0]["cash"] + + # Getting total amount of money spent in each category + amounts = [] + categories = ['%Rent', '%Maintenance', '%Food', '%Family', '%Pets', '%Clothes', '%Hobbies', '%Investing', '%Other'] + + for element in categories: + result = db.execute("SELECT SUM(amount) FROM expenses WHERE user_id = ? AND category LIKE ?", user_id, element)[0]["SUM(amount)"] + if result == None: + result = 0 + amounts.append(result) + + return render_template("home.html", name=username, cash=cash, rent=amounts[0], maintain=amounts[1], food=amounts[2], family=amounts[3], + pets=amounts[4], clothes=amounts[5], hobbies=amounts[6], invest=amounts[7], other=amounts[8]) + + +@app.route("/account", methods=["GET", "POST"]) +@login_required +def account(): + """ View user data & replace passsword """ + + user_id = session["user_id"] + user_info = db.execute("SELECT * FROM users WHERE id = ?", user_id) + username = user_info[0]["username"] + cash = user_info[0]["cash"] + + if request.method == "GET": + return render_template("account.html", name=username, budget=cash) + + else: + # allowing the user to set a new password for their account + pw_new = request.form.get("pw_new") + if not check_password_hash(user_info[0]["hash"], request.form.get("pw_old")): + return apology("Your old password was not correct", 400) + elif pw_new != request.form.get("confirmation"): + return apology("New Password and Confirm New Password did not match", 400) + elif passw_requirements(pw_new) != "valid": + return apology("Password must be between 6 and 25 characters long and contain at least one number and one letter", 400) + + # replace password in the db if all requirements were met + db.execute("UPDATE users SET hash = ? WHERE username = ?", generate_password_hash(pw_new), username) + flash("You successfully changed your password!") + return render_template("/account.html", name=username, budget=cash) + + +@app.route("/bargain", methods=["GET", "POST"]) +@login_required +def bargain(): + """Search for & display cheapest deals for a user-specified item """ + + # display search form + if request.method == "GET": + return render_template("bargain.html") + # display results collected & sorted by web scraping helper function + else: + item = request.form.get("product-search") + deals = deal_finder(item) + + return render_template("bargain.html", deals=deals) + + +@app.route("/budget", methods=["GET", "POST"]) +@login_required +def budget(): + """ View & set budget """ + + user_id = session["user_id"] + budget = db.execute("SELECT cash FROM users WHERE id = ?", user_id)[0]["cash"] + + # view current budget + if request.method == "GET": + return render_template("budget.html", budget=budget) + + # update budget + else: + added_budget = request.form.get("add_budget") + new_budget = float(budget) + float(added_budget) + db.execute("UPDATE users SET cash = ? WHERE id = ?", new_budget, user_id) + + flash("Budget updated!") + return render_template("budget.html", budget=new_budget) + + +@app.route("/history") +@login_required +def history(): + """ Show record of all previous expenses """ + + user_id = session["user_id"] + record = db.execute("SELECT * FROM expenses WHERE user_id = ? ORDER BY date", user_id) + return render_template("history.html", record=record) + + +@app.route("/login", methods=["GET", "POST"]) +def login(): + """Log user in""" + + # Forget any user_id + session.clear() + + # User reached the route via GET: + if request.method == "GET": + return render_template("login.html") + + # User submitted via POST to log in: + else: + # Ensure username was submitted + if not request.form.get("username"): + return apology("must provide username", 403) + + # Ensure password was submitted + elif not request.form.get("password"): + return apology("must provide password", 403) + + # Query database for username + rows = db.execute("SELECT * FROM users WHERE username = ?", request.form.get("username")) + + # Ensure username exists and password is correct + if len(rows) != 1 or not check_password_hash(rows[0]["hash"], request.form.get("password")): + return apology("invalid username and/or password", 403) + + # Remember which user has logged in + session["user_id"] = rows[0]["id"] + + # Redirect user to home page + return redirect("/") + + +@app.route("/logout") +def logout(): + """Log user out""" + + # Forget any user_id + session.clear() + + # Redirect user to login form + return redirect("/") + + +@app.route("/register", methods=["GET", "POST"]) +def register(): + """ Register a new user account """ + + # If the user visits this route, display the form to sign up for a new account + if request.method == "GET": + return render_template("register.html") + + # If the user submits their registration with POST + else: + # Get the user's name & password from the form + reg_name = request.form.get("username") + reg_passw = request.form.get("password") + + # Checking if the user failed to provide a username & password, if the name is already taken or if the confirmed password was different + if not reg_name: + return apology("Please enter a username", 400) + elif len(db.execute("SELECT * FROM users WHERE username = ?", reg_name)) != 0: + return apology("Username is already taken", 400) + elif not reg_passw: + return apology("Please choose a unique password", 400) + elif reg_passw != request.form.get("confirmation"): + return apology("Password and Confirm Password did not match", 400) + # Special check with a helper function for password safety + elif passw_requirements(reg_passw) != "valid": + return apology("Password must be between 6 and 25 characters long and contain at least one number and one letter", 400) + + # Otherwise register the new user into the database (with a hashed password for extra security) and redirect them to the main page + db.execute("INSERT INTO users (username, hash) VALUES (?, ?)", reg_name, generate_password_hash(reg_passw)) + return redirect("/login") + + +@app.route("/tracker", methods=["POST", "GET"]) +@login_required +def tracker(): + """ Add new expenses """ + + # Display form to add a new expense + if request.method == "GET": + return render_template("tracker.html") + # When submitting a new expense: + else: + user_id = session["user_id"] + budget = db.execute("SELECT cash FROM users WHERE id = ?", user_id)[0]["cash"] + + # ternary condition if the user does not give an optional comment on the expense + comment = "Unspecified" if not request.form.get("comment") else request.form.get("comment") + category, amount, date = request.form.get("category"), request.form.get("amount", type=float), request.form.get("date") + + # subtract expense from budget + updated_budget = float(budget) - amount + db.execute("UPDATE users SET cash = ? WHERE id = ?", updated_budget, user_id) + + # update table "expenses" in database for use in history.html + db.execute("INSERT INTO expenses (user_id, comment, category, amount, date) VALUES (?, ?, ?, ?, ?)", + user_id, comment, category, amount, date) + return redirect("/") + + +# Handle errors +def errorhandler(e): + if not isinstance(e, HTTPException): + e = InternalServerError() + return apology(e.name, e.code) + + +# Listen for errors +for code in default_exceptions: + app.errorhandler(code)(errorhandler) diff --git a/helpers.py b/helpers.py new file mode 100644 index 0000000..e55b395 --- /dev/null +++ b/helpers.py @@ -0,0 +1,96 @@ +import os +import re +import requests +import urllib.parse + +from bs4 import BeautifulSoup +from flask import flash, redirect, render_template, request, session +from functools import wraps + + +# Display apology message in case of an error +def apology(message, code=400): + def escape(s): + """ + Escape special characters. + + https://github.com/jacebrowning/memegen#special-characters + """ + for old, new in [("-", "--"), (" ", "-"), ("_", "__"), ("?", "~q"), + ("%", "~p"), ("#", "~h"), ("/", "~s"), ("\"", "''")]: + s = s.replace(old, new) + return s + flash("Apologies, something went wrong...") + return render_template("apology.html", top=code, bottom=escape(message)), code + + +def deal_finder(item): + """ Scraping best deals on ebay for the user-specified item """ + + # https://www.networkinghowtos.com/howto/common-user-agent-list/ + header = {'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36'} + # https://stackoverflow.com/questions/1549641/how-can-i-capitalize-the-first-letter-of-each-word-in-a-string + item_spelling = " ".join(word[0].upper() + word[1:] for word in item.split()) + + # Setup for displaying ebay results with the filter option "Price + Shipping: lowest first" + search_term = item.replace(" ", "+") + url = f"https://www.ebay.com/sch/i.html?_from=R40&_trksid=p2380057.m570.l1313&_nkw={search_term}&_sacat=0&_sop=15" + webpage = requests.get(url, headers=header).text + soup = BeautifulSoup(webpage, "lxml") + + offers = {} + # getting a list of all divs that contain the info on each individual offer + all_offers = soup.find_all("div", class_="s-item__info clearfix") + for item in all_offers: + # checking for matches in all caps too + if item.find(text=re.compile(item_spelling)) != None and item.find(text=re.compile(item_spelling.upper())) == None: + name = item.find(text=re.compile(item_spelling)) + elif item.find(text=re.compile(item_spelling)) == None and item.find(text=re.compile(item_spelling.upper())) != None: + name = item.find(text=re.compile(item_spelling.upper())) + else: + continue + + # getting the price of each item + if item.find("span", class_="s-item__price").string == None: + continue + price = item.find("span", class_="s-item__price").string.replace("$", "") + + # getting the link to the page of each item + if item.a["href"] == None: + continue + link = item.a["href"] + + # the following code for "offers" & "best_deals" is based on: https://www.youtube.com/watch?v=zAEfWiC_KBU&t=1232s + offers[name] = {"price": float(price.replace(",", "")), "link": link} + + best_deals = sorted(offers.items(), key=lambda x: x[1]["price"]) + return(best_deals) + + +def login_required(f): + """ + Decorate routes to require login. + + https://flask.palletsprojects.com/en/1.1.x/patterns/viewdecorators/ + """ + @wraps(f) + def decorated_function(*args, **kwargs): + if session.get("user_id") is None: + return redirect("/login") + return f(*args, **kwargs) + return decorated_function + + +def passw_requirements(password): + """ Password requirements for registrating an account """ + + pw_length = len(password) + if pw_length in range(6,25) and password.isalpha() == False and password.isnumeric() == False: + return "valid" + else: + return "invalid" + + +# Display a float as US-Dollar +def usd(value): + return f"${value:,.2f}" diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..2c40772 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +Beautiful Soup +cs50 +Flask +Flask-Session +re +requests diff --git a/spending.db b/spending.db Binary files differnew file mode 100644 index 0000000..776e6a7 --- /dev/null +++ b/spending.db diff --git a/static/Sparschwein.png b/static/Sparschwein.png Binary files differnew file mode 100644 index 0000000..30283d3 --- /dev/null +++ b/static/Sparschwein.png diff --git a/static/bouncer.jpg b/static/bouncer.jpg Binary files differnew file mode 100644 index 0000000..c050c13 --- /dev/null +++ b/static/bouncer.jpg diff --git a/static/couple_piggy.png b/static/couple_piggy.png Binary files differnew file mode 100644 index 0000000..d68040b --- /dev/null +++ b/static/couple_piggy.png diff --git a/static/filter.js b/static/filter.js new file mode 100644 index 0000000..9318c23 --- /dev/null +++ b/static/filter.js @@ -0,0 +1,34 @@ +// Filter-search a table +// Code expanded from this source: https://www.w3schools.com/howto/howto_js_filter_table.asp + +function filter() { + let selector, val; + selector = document.getElementsByName("select"); + + // Loop through the radio buttons to determine the filter-settings + for (let i = 0; i < selector.length; i++) { + if (selector[i].checked) { + val = parseInt(selector[i].value); + break; + } + } + + let input, insensitive, table, tr, td, txtValue; + input = document.getElementById("search_history"); + insensitive = input.value.toUpperCase(); + table = document.getElementById("history"); + tr = table.getElementsByTagName("tr"); + + // Loop through all table rows, and hide those that don't match the search query + for (let i = 0; i < tr.length; i++) { + td = tr[i].getElementsByTagName("td")[val]; + if (td) { + txtValue = td.textContent || td.innerText; + if (txtValue.toUpperCase().indexOf(insensitive) > -1) { + tr[i].style.display = ""; + } else { + tr[i].style.display = "none"; + } + } + } +} diff --git a/static/green_dollar.jpg b/static/green_dollar.jpg Binary files differnew file mode 100644 index 0000000..a4d423c --- /dev/null +++ b/static/green_dollar.jpg diff --git a/static/green_piggy.png b/static/green_piggy.png Binary files differnew file mode 100644 index 0000000..84da5d4 --- /dev/null +++ b/static/green_piggy.png diff --git a/static/piechart.js b/static/piechart.js new file mode 100644 index 0000000..9baab35 --- /dev/null +++ b/static/piechart.js @@ -0,0 +1,84 @@ +// Change background image depending on budget balance +document.addEventListener('DOMContentLoaded', function() { + let budget = document.getElementById('budget').innerHTML.split('$').pop(); + if (parseFloat(budget) <= 0) { + document.getElementById('dollar').setAttribute('src', '/static/red_dollar.jpg'); + } else { + document.getElementById('dollar').setAttribute('src', '/static/green_dollar.jpg'); + } +}); + +// https://www.chartjs.org/docs/latest/ +// https://chartjs-plugin-datalabels.netlify.app/guide/getting-started.html +let context, labels, colors, data, source; +//Pie chart settings +context = document.getElementById('piechart').getContext('2d'); +labels = [ + 'Rent & Bills', + 'Maintenance', + 'Food', + 'Family', + 'Pets', + 'Clothes', + 'Hobbies & Entertainment', + 'Investing', + 'Other' +]; + +colors = [ + '#f75a3a', + '#1288da', + '#ffc300', + '#ffe7b0', + '#f39ad9', + '#6dc9ff', + '#ffc31d', + '#71e748', + '#b10981' +]; + +// Getting the data from hidden HTML div +data = []; +source = document.getElementById('hidden_data').getElementsByTagName('p'); +for (let i = 0; i < source.length; i++) { + data.push(source[i].innerHTML); +} + + +// Pie chart +let myPie = new Chart(context, { + type: 'pie', + data: { + labels: labels, + datasets: [{ + data: data, + backgroundColor: colors + }] + }, + options: { + plugins: { + datalabels: { + borderColor: '#000', + color: 'black', + align: 'start', + font: { + weight: 'bold', + size: '14' + }, + formatter: (value) => { + return '$ ' + value; + } + }, + legend: { + position: 'right', + align: 'center' + }, + title: { + display: false, + text: "Title" + } + }, + responsive: true + }, + plugins: [ChartDataLabels] +}); diff --git a/static/piggy_categories.png b/static/piggy_categories.png Binary files differnew file mode 100644 index 0000000..12a3afe --- /dev/null +++ b/static/piggy_categories.png diff --git a/static/piggy_green__transp.png b/static/piggy_green__transp.png Binary files differnew file mode 100644 index 0000000..abc239d --- /dev/null +++ b/static/piggy_green__transp.png diff --git a/static/piggy_happy.png b/static/piggy_happy.png Binary files differnew file mode 100644 index 0000000..a4291aa --- /dev/null +++ b/static/piggy_happy.png diff --git a/static/piggy_house.png b/static/piggy_house.png Binary files differnew file mode 100644 index 0000000..56c42e3 --- /dev/null +++ b/static/piggy_house.png diff --git a/static/piggy_increase.jpg b/static/piggy_increase.jpg Binary files differnew file mode 100644 index 0000000..9ba9694 --- /dev/null +++ b/static/piggy_increase.jpg diff --git a/static/piggy_increase_transp.png b/static/piggy_increase_transp.png Binary files differnew file mode 100644 index 0000000..f179153 --- /dev/null +++ b/static/piggy_increase_transp.png diff --git a/static/piggy_laptop.png b/static/piggy_laptop.png Binary files differnew file mode 100644 index 0000000..5170dae --- /dev/null +++ b/static/piggy_laptop.png diff --git a/static/piggy_main.jpg b/static/piggy_main.jpg Binary files differnew file mode 100644 index 0000000..66b7056 --- /dev/null +++ b/static/piggy_main.jpg diff --git a/static/piggy_smashed.png b/static/piggy_smashed.png Binary files differnew file mode 100644 index 0000000..1f434e7 --- /dev/null +++ b/static/piggy_smashed.png diff --git a/static/red_dollar.jpg b/static/red_dollar.jpg Binary files differnew file mode 100644 index 0000000..94b9d30 --- /dev/null +++ b/static/red_dollar.jpg diff --git a/static/styles.css b/static/styles.css new file mode 100644 index 0000000..ac4a055 --- /dev/null +++ b/static/styles.css @@ -0,0 +1,142 @@ +/* Markes the currently active nav tab */ +#active-nav { + color: black; + background-color: #0dce1d; + border-radius: 25px; + border: 2px; + text-decoration: none; +} + +#header-main { + color: #0a762c; + font-family: 'Josefin Sans', sans-serif; + font-size: 44px; + font-weight: bold +} + +#name { + color: #0a762c; + font-family: 'Lucida Handwriting', cursive; + font-size: 28px; + font-weight: bold; +} + +#text-welcome { + font-family: 'Josefin Sans', sans-serif; + font-style: italic; + font-weight: bold; + margin-top: 10px; + margin-bottom: 10px; + text-align: justify; +} + +/* Displaying prices from bargain finder */ +.bargain-price { + color: green; + font-size: 22px; + font-weight: bold; +} + +.carousel-img { + width: 40%; + height: auto; +} + +.carousel-text { + font-weight: bold; +} + +.container-money { + position: relative; + text-align: center; +} + +/* Float value displayed on top of dollar bill */ +.centered-money { + color: black; + font-size: 30px; + font-weight: bold; + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); +} + +.footnote { + font-size: 11px; + margin-top: 5px; +} + +.pie-wrapper { + width: 100%; + height: auto; + max-width: 600px; +} + +.text { + font-size: 20px; +} + +.text-bullet { + font-size: 20px; + font-style: italic; + font-weight: bold; + margin-top: 10px; + margin-bottom: 10px; +} + +body { + background-color: #f7f6f2; +} + +input { + margin-top: 10px; +} + +/* Increase the default size of radio buttons */ +input[type='radio'] { + margin: 10px; + transform: scale(1.5); +} + +main .form-control { + /* Center form controls */ + display: inline-block; + + /* Override Bootstrap's 100% width for form controls */ + width: auto; +} + +main { + /* Scroll horizontally as needed */ + overflow-x: auto; + + /* Center contents */ + text-align: center; +} + +/* Constrain images on small screens */ +main img { + max-width: 100%; +} + +nav .nav-item { + margin-left: 10px; + margin-right: 10px; +} + +nav .navbar-brand { + font-size: xx-large; + margin-left: 15px; +} + +nav .navbar-title { + color: white; + font-weight: bold; + margin-left: 20px; +} + +.navbar-nav .nav-item .nav-link { + color: white; + text-decoration: none; +} diff --git a/static/unused/green_dollar_stack.jpg b/static/unused/green_dollar_stack.jpg Binary files differnew file mode 100644 index 0000000..ca99e95 --- /dev/null +++ b/static/unused/green_dollar_stack.jpg diff --git a/static/unused/pngtree-stacks-of-dollar-banknotes-png-image_3432876.jpg b/static/unused/pngtree-stacks-of-dollar-banknotes-png-image_3432876.jpg Binary files differnew file mode 100644 index 0000000..115a362 --- /dev/null +++ b/static/unused/pngtree-stacks-of-dollar-banknotes-png-image_3432876.jpg diff --git a/static/unused/pngtree-two-thick-stacks-of-dollar-banknotes-png-image_3432831.jpg b/static/unused/pngtree-two-thick-stacks-of-dollar-banknotes-png-image_3432831.jpg Binary files differnew file mode 100644 index 0000000..2100f0a --- /dev/null +++ b/static/unused/pngtree-two-thick-stacks-of-dollar-banknotes-png-image_3432831.jpg diff --git a/static/unused/red_dollar_stack.jpg b/static/unused/red_dollar_stack.jpg Binary files differnew file mode 100644 index 0000000..134e812 --- /dev/null +++ b/static/unused/red_dollar_stack.jpg diff --git a/templates/account.html b/templates/account.html new file mode 100644 index 0000000..68b1abf --- /dev/null +++ b/templates/account.html @@ -0,0 +1,62 @@ +{% extends "layout.html"%} + +{% block title %} + Account +{% endblock %} + +{% block main %} +<div class="row row-cols-2"> + <!-- Username --> + <div class="col-lg-3 col-md-3 col-sm-3 col-xs-12 float-start"> + <div class="card text-white bg-success mb-3 float-start w-100" style="max-width: 18rem;"> + <div class="card-header"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-file-person" viewBox="0 0 16 16"> + <path d="M12 1a1 1 0 0 1 1 1v10.755S12 11 8 11s-5 1.755-5 1.755V2a1 1 0 0 1 1-1h8zM4 0a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h8a2 2 0 0 0 2-2V2a2 2 0 0 0-2-2H4z"/> + <path d="M8 10a3 3 0 1 0 0-6 3 3 0 0 0 0 6z"/> + </svg> Username</div> + <div class="card-body"> + <h5 class="card-title">{{ name }}</h5> + </div> + </div> + + <!-- Budget --> + <div class="card text-white bg-success mb-3 float-start w-100" style="max-width: 18rem;"> + <div class="card-header"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-cash" viewBox="0 0 16 16"> + <path d="M8 10a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/> + <path d="M0 4a1 1 0 0 1 1-1h14a1 1 0 0 1 1 1v8a1 1 0 0 1-1 1H1a1 1 0 0 1-1-1V4zm3 0a2 2 0 0 1-2 2v4a2 2 0 0 1 2 2h10a2 2 0 0 1 2-2V6a2 2 0 0 1-2-2H3z"/> + </svg> Budget</div> + <div class="card-body"> + <h5 class="card-title">{{ budget | usd }}</h5> + </div> + </div> + + <!-- Choose new password --> + <div class="card text-white bg-success mb-3 float-start w-100" style="max-width: 18rem;"> + <div class="card-header"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-key-fill" viewBox="0 0 16 16"> + <path d="M3.5 11.5a3.5 3.5 0 1 1 3.163-5H14L15.5 8 14 9.5l-1-1-1 1-1-1-1 1-1-1-1 1H6.663a3.5 3.5 0 0 1-3.163 2zM2.5 9a1 1 0 1 0 0-2 1 1 0 0 0 0 2z"/> + </svg> Reset Password</div> + <div class="card-body"> + <form action="/account" method="post"> + <label for="pw_old">Current Password</label> + <input name="pw_old" autocomplete="off" class="form-control" placeholder="Current Password" type="password" required> + + <label for="pw_new">New Password</label><br> + <input name="pw_new" autocomplete="off" class="form-control" placeholder="New Password" type="password" required> + <p class="footnote">* Password must be between 6-25 characters long and contain at least one number and one letter</p> + + <label for="confirmation">Confirm New Password</label> + <input class="form-control" autocomplete="off" name="confirmation" placeholder="Confirm New Password" type="password" required> + <p class="footnote">* Your input must match the password above</p> + <button class="btn btn-dark" type="submit">Change Password</button> + </form> + </div> + </div> + </div> + + <div class="col float-end" style="margin-top: 20px;"> + <img src="/static/piggy_laptop.png" class="float-end"> + </div> +</div> +{% endblock %} diff --git a/templates/apology.html b/templates/apology.html new file mode 100644 index 0000000..f8b22b6 --- /dev/null +++ b/templates/apology.html @@ -0,0 +1,12 @@ +{% extends "layout.html" %} + +{% block title %} + Apology +{% endblock %} + +{% block main %} + <!-- alternative image bouncer: https://t3.ftcdn.net/jpg/01/18/77/66/240_F_118776660_d6FDZKGs2tnFLn50wyHG87yfeZQhWhU0.jpg --> + <img alt="{{ top }}" class="border" src="http://memegen.link/custom/{{ top | urlencode }}/{{ bottom | urlencode }}.jpg?alt=https://image.freepik.com/vektoren-kostenlos/realistisches-design-des-insolvenzkonzepts_52683-36058.jpg" title="{{ top }}"> + <br> + <a button href="/" class="btn btn-success" role="button" style="margin-top: 20px">Return to Main Page</a> +{% endblock %}
\ No newline at end of file diff --git a/templates/bargain.html b/templates/bargain.html new file mode 100644 index 0000000..50abde7 --- /dev/null +++ b/templates/bargain.html @@ -0,0 +1,53 @@ +{% extends "layout.html"%} + +{% block title %} + Bargain Finder +{% endblock %} + +{% block main %} +<!-- Search for item --> +<div> + <form action="/bargain" method="post"> + <div class="form-group"> + <label for="product-search" class="text">What item are you looking for?</label> + </div> + <br> + <div class="form-group"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-search" viewBox="0 0 16 16" style="margin-right: 5px;"> + <path d="M11.742 10.344a6.5 6.5 0 1 0-1.397 1.398h-.001c.03.04.062.078.098.115l3.85 3.85a1 1 0 0 0 1.415-1.414l-3.85-3.85a1.007 1.007 0 0 0-.115-.1zM12 6.5a5.5 5.5 0 1 1-11 0 5.5 5.5 0 0 1 11 0z"/> + </svg> + <input autocomplete="off" autofocus class="form-control" name="product-search" placeholder="Search for..." type="text" required> + </div> + <br> + <button class="btn btn-success" type="submit"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-piggy-bank" viewBox="0 0 16 16"> + <path d="M5 6.25a.75.75 0 1 1-1.5 0 .75.75 0 0 1 1.5 0zm1.138-1.496A6.613 6.613 0 0 1 7.964 4.5c.666 0 1.303.097 1.893.273a.5.5 0 0 0 .286-.958A7.602 7.602 0 0 0 7.964 3.5c-.734 0-1.441.103-2.102.292a.5.5 0 1 0 .276.962z"/> + <path fill-rule="evenodd" d="M7.964 1.527c-2.977 0-5.571 1.704-6.32 4.125h-.55A1 1 0 0 0 .11 6.824l.254 1.46a1.5 1.5 0 0 0 1.478 1.243h.263c.3.513.688.978 1.145 1.382l-.729 2.477a.5.5 0 0 0 .48.641h2a.5.5 0 0 0 .471-.332l.482-1.351c.635.173 1.31.267 2.011.267.707 0 1.388-.095 2.028-.272l.543 1.372a.5.5 0 0 0 .465.316h2a.5.5 0 0 0 .478-.645l-.761-2.506C13.81 9.895 14.5 8.559 14.5 7.069c0-.145-.007-.29-.02-.431.261-.11.508-.266.705-.444.315.306.815.306.815-.417 0 .223-.5.223-.461-.026a.95.95 0 0 0 .09-.255.7.7 0 0 0-.202-.645.58.58 0 0 0-.707-.098.735.735 0 0 0-.375.562c-.024.243.082.48.32.654a2.112 2.112 0 0 1-.259.153c-.534-2.664-3.284-4.595-6.442-4.595zM2.516 6.26c.455-2.066 2.667-3.733 5.448-3.733 3.146 0 5.536 2.114 5.536 4.542 0 1.254-.624 2.41-1.67 3.248a.5.5 0 0 0-.165.535l.66 2.175h-.985l-.59-1.487a.5.5 0 0 0-.629-.288c-.661.23-1.39.359-2.157.359a6.558 6.558 0 0 1-2.157-.359.5.5 0 0 0-.635.304l-.525 1.471h-.979l.633-2.15a.5.5 0 0 0-.17-.534 4.649 4.649 0 0 1-1.284-1.541.5.5 0 0 0-.446-.275h-.56a.5.5 0 0 1-.492-.414l-.254-1.46h.933a.5.5 0 0 0 .488-.393zm12.621-.857a.565.565 0 0 1-.098.21.704.704 0 0 1-.044-.025c-.146-.09-.157-.175-.152-.223a.236.236 0 0 1 .117-.173c.049-.027.08-.021.113.012a.202.202 0 0 1 .064.199z"/> + </svg> Find me the best deals!</button> + </form> +</div> +<br> + +<!-- Display search results from web scraper --> +<div> + <ol> + {% for item in deals %} + <li> + <div class="card border-dark mb-3" style="background-color: #fffde6;"> + <div class="card-body text-dark"> + <h6 class="card-title">{{ item[0] }}</h6> + <p class="card-text"> + <span class="bargain-price">{{ item[1]['price'] | usd }}</span> + <a href="{{ item[1]['link'] }}" class="btn btn-primary float-end" target="_blank">Go to Deal</a> + </p> + </div> + </div> + </li> + {% endfor %} + </ol> +</div> + +<div> + <img src="/static/piggy_increase.png" alt="Increase your savings!"> +</div> +{% endblock %} diff --git a/templates/budget.html b/templates/budget.html new file mode 100644 index 0000000..82fbbad --- /dev/null +++ b/templates/budget.html @@ -0,0 +1,52 @@ +{% extends "layout.html"%} + +{% block title %} + Budget +{% endblock %} + +{% block main %} +<div class="row align-items-start row-cols-2"> + <!-- Display current budget--> + <div class="col" style="margin-top: 120px;"> + <p style="font-size: 20px; font-weight: bold;">Your budget:</p> + <div class="container-money"> + <img id="dollar" src="/static/red_dollar.jpg" alt="dollar bill"> + <div class="centered-money"> + <span id="budget">{{ budget | usd }}</span> + </div> + </div><br> + <!-- Set new budget --> + <div> + <form action="/budget" method="post"> + <div class="mb-3"> + <label for="add_budget" style="margin-top: 30px; font-weight: bold;"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-cash-stack" viewBox="0 0 16 16"> + <path d="M1 3a1 1 0 0 1 1-1h12a1 1 0 0 1 1 1H1zm7 8a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/> + <path d="M0 5a1 1 0 0 1 1-1h14a1 1 0 0 1 1 1v8a1 1 0 0 1-1 1H1a1 1 0 0 1-1-1V5zm3 0a2 2 0 0 1-2 2v4a2 2 0 0 1 2 2h10a2 2 0 0 1 2-2V7a2 2 0 0 1-2-2H3z"/> + </svg> Set your budget + </label><br> + + <span style="font-size: 20px; margin-right: 5px;">$</span> + <input name="add_budget" autocomplete="off" autofocus class="form-control" placeholder="Add Budget..." type="number" min="1.00" step="0.01" required> + </div> + <button class="btn btn-success" type="submit">Update Budget</button> + </form> + </div> + </div> + <div class="col"> + <img src="/static/piggy_green.png"><br> + </div> +</div> + +<!-- Change budget background image depending on budget balance --> +<script> + document.addEventListener('DOMContentLoaded', function() { + let budget = document.getElementById('budget').innerHTML.split('$').pop(); + if (parseFloat(budget) <= 0) { + document.getElementById('dollar').setAttribute('src', '/static/red_dollar.jpg'); + } else { + document.getElementById('dollar').setAttribute('src', '/static/green_dollar.jpg'); + } + }); +</script> +{% endblock %} diff --git a/templates/history.html b/templates/history.html new file mode 100644 index 0000000..e461269 --- /dev/null +++ b/templates/history.html @@ -0,0 +1,51 @@ +{% extends "layout.html" %} + +{% block title %} + Spending History +{% endblock %} + +{% block main %} + <!-- Option to search & filter the table --> + <div class="mb-4"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-search" viewBox="0 0 16 16" style="margin-right: 5px;"> + <path d="M11.742 10.344a6.5 6.5 0 1 0-1.397 1.398h-.001c.03.04.062.078.098.115l3.85 3.85a1 1 0 0 0 1.415-1.414l-3.85-3.85a1.007 1.007 0 0 0-.115-.1zM12 6.5a5.5 5.5 0 1 1-11 0 5.5 5.5 0 0 1 11 0z"/> + </svg> + <input type="text" id="search_history" onkeyup="filter()" placeholder="Filter for:"> + + <input type="radio" id="expense" name="select" value="0" checked> + <label for="expense">Expense</label> + <input type="radio" id="category" name="select" value="1"> + <label for="category">Category</label> + <input type="radio" id="amount" name="select" value="2"> + <label for="amount">Amount</label> + <input type="radio" id="date" name="select" value="3"> + <label for="date">Date</label><br> + </div> + + <!-- Table displaying details of all user-submitted expenses, sorted by date --> + <div class="table-responsive"> + <table class="table table-success table-striped table-hover" id="history"> + <thead class="table-dark"> + <tr> + <th>Expense</th> + <th>Category</th> + <th>Amount</th> + <th>Date</th> + </tr> + </thead> + <tbody> + {% for item in record %} + <tr> + <td>{{ item.comment }}</td> + <td>{{ item.category }}</td> + <td><strong>- {{ item.amount | usd }}</strong></td> + <td>{{ item.date }}</td> + </tr> + {% endfor %} + </tbody> + </table> + </div> + + <!-- Implements search & filters --> + <script src="/static/filter.js"></script> +{% endblock %} diff --git a/templates/home.html b/templates/home.html new file mode 100644 index 0000000..88cb567 --- /dev/null +++ b/templates/home.html @@ -0,0 +1,55 @@ +{% extends "layout.html"%} + +{% block title %} + Home +{% endblock %} + +{% block main %} +<!-- Budget & spending statistics --> +<div class="container-md"> + <p style="font-size: 24px;">Hi there, <span id="name">{{ name }}</span> !</p> + <h5>Your budget:</h5> + <div class="container-money"> + <img id="dollar" src="/static/red_dollar.jpg" alt="dollar bill"> + <div class="centered-money"> + <span id="budget">{{ cash | usd }}</span> + </div> + </div> +</div> + +<!-- Data used to implement pie chart, div itself not meant to be displayed --> +<div id="hidden_data" style="display: none;"> + <p>{{ rent }}</p> + <p>{{ maintain }}</p> + <p>{{ food }}</p> + <p>{{ family }}</p> + <p>{{ pets }}</p> + <p>{{ clothes }}</p> + <p>{{ hobbies }}</p> + <p>{{ invest }}</p> + <p>{{ other }}</p> +</div> + +<div class="row align-items-start row-cols-2" style="margin-top: 100px;"> + <div class="col"> + <div class="pie-wrapper"> + <label for="piechart"><h5> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-bar-chart-fill" viewBox="0 0 16 16"> + <path d="M1 11a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1v-3zm5-4a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H7a1 1 0 0 1-1-1V7zm5-5a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1h-2a1 1 0 0 1-1-1V2z"/> + </svg> Your total expenses</h5></label> + <canvas id="piechart"></canvas> + </div> + </div> + + <div class="col" style="margin-top: 210px;"> + <img src="/static/piggy_main.jpg" alt="Increase your savings!"> + </div> +</div> + +<!-- https://www.chartjs.org/docs/latest/ --> +<script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/3.6.2/chart.min.js" integrity="sha512-tMabqarPtykgDtdtSqCL3uLVM0gS1ZkUAVhRFu1vSEFgvB73niFQWJuvviDyBGBH22Lcau4rHB5p2K2T0Xvr6Q==" crossorigin="anonymous" referrerpolicy="no-referrer"></script> +<!-- https://chartjs-plugin-datalabels.netlify.app/guide/getting-started.html#installation --> +<script src="https://cdn.jsdelivr.net/npm/chartjs-plugin-datalabels@2.0.0"></script> + +<script src="/static/piechart.js"></script> +{% endblock %} diff --git a/templates/layout.html b/templates/layout.html new file mode 100644 index 0000000..89eb716 --- /dev/null +++ b/templates/layout.html @@ -0,0 +1,115 @@ +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="initial-scale=1, width=device-width"> + + <!-- Bootstrap: https://getbootstrap.com/docs/5.1/getting-started/introduction/ --> + <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous"> + <!-- Google Fonts: https://fonts.google.com/ --> + <link href="https://fonts.googleapis.com/css2?family=Montserrat:wght@500&display=swap" rel="stylesheet"> + + <!-- https://www.flaticon.com/de/kostenloses-icon/sparschwein_1787030 --> + <link href="/static/Sparschwein.png" rel="icon"> + <link href="/static/styles.css" rel="stylesheet"> + + <!-- Bootstrap's JavaScript Bundle with Popper --> + <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" crossorigin="anonymous"></script> + + <title>Total Expense: {% block title %}{% endblock %}</title> + </head> + + <body> + <nav class="navbar navbar-expand-lg navbar-dark bg-dark"> + <a class="navbar-brand" href="/"><img src="/static/Sparschwein.png" width="100" height="100"><span class="navbar-title">Total Expense</span></a> + <button aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation" class="navbar-toggler" data-target="#navbar" data-toggle="collapse" type="button"> + <span class="navbar-toggler-icon"></span> + </button> + + <div class="collapse navbar-collapse" id="navbar"> + <!-- Nav tabs on the left for logged-in-user --> + {% if session.user_id %} + <ul class="navbar-nav me-auto mt-2"> + <li class="nav-item"> + <!-- Check for each nav link if currently active, add id for different display if so --> + <a class="nav-link" {% if request.path == '/' %}id="active-nav"{% endif %} href="/"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-piggy-bank-fill" viewBox="0 0 16 16"> + <path fill-rule="evenodd" d="M7.964 1.527c-2.977 0-5.571 1.704-6.32 4.125h-.55A1 1 0 0 0 .11 6.824l.254 1.46a1.5 1.5 0 0 0 1.478 1.243h.263c.3.513.688.978 1.145 1.382l-.729 2.477a.5.5 0 0 0 .48.641h2a.5.5 0 0 0 .471-.332l.482-1.351c.635.173 1.31.267 2.011.267.707 0 1.388-.095 2.028-.272l.543 1.372a.5.5 0 0 0 .465.316h2a.5.5 0 0 0 .478-.645l-.761-2.506C13.81 9.895 14.5 8.559 14.5 7.069c0-.145-.007-.29-.02-.431.261-.11.508-.266.705-.444.315.306.815.306.815-.417 0 .223-.5.223-.461-.026a.95.95 0 0 0 .09-.255.7.7 0 0 0-.202-.645.58.58 0 0 0-.707-.098.735.735 0 0 0-.375.562c-.024.243.082.48.32.654a2.112 2.112 0 0 1-.259.153c-.534-2.664-3.284-4.595-6.442-4.595zm7.173 3.876a.565.565 0 0 1-.098.21.704.704 0 0 1-.044-.025c-.146-.09-.157-.175-.152-.223a.236.236 0 0 1 .117-.173c.049-.027.08-.021.113.012a.202.202 0 0 1 .064.199zm-8.999-.65A6.613 6.613 0 0 1 7.964 4.5c.666 0 1.303.097 1.893.273a.5.5 0 1 0 .286-.958A7.601 7.601 0 0 0 7.964 3.5c-.734 0-1.441.103-2.102.292a.5.5 0 1 0 .276.962zM5 6.25a.75.75 0 1 1-1.5 0 .75.75 0 0 1 1.5 0z"/> + </svg> Home</a> + </li> + <li class="nav-item"> + <a class="nav-link" {% if request.path == '/budget' %}id="active-nav"{% endif %} href="/budget"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-wallet2" viewBox="0 0 16 16"> + <path d="M12.136.326A1.5 1.5 0 0 1 14 1.78V3h.5A1.5 1.5 0 0 1 16 4.5v9a1.5 1.5 0 0 1-1.5 1.5h-13A1.5 1.5 0 0 1 0 13.5v-9a1.5 1.5 0 0 1 1.432-1.499L12.136.326zM5.562 3H13V1.78a.5.5 0 0 0-.621-.484L5.562 3zM1.5 4a.5.5 0 0 0-.5.5v9a.5.5 0 0 0 .5.5h13a.5.5 0 0 0 .5-.5v-9a.5.5 0 0 0-.5-.5h-13z"/> + </svg> Set Budget</a> + </li> + <li class="nav-item"> + <a class="nav-link" {% if request.path == '/tracker' %}id="active-nav"{% endif %} href="/tracker"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-calculator-fill" viewBox="0 0 16 16"> + <path d="M2 2a2 2 0 0 1 2-2h8a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V2zm2 .5v2a.5.5 0 0 0 .5.5h7a.5.5 0 0 0 .5-.5v-2a.5.5 0 0 0-.5-.5h-7a.5.5 0 0 0-.5.5zm0 4v1a.5.5 0 0 0 .5.5h1a.5.5 0 0 0 .5-.5v-1a.5.5 0 0 0-.5-.5h-1a.5.5 0 0 0-.5.5zM4.5 9a.5.5 0 0 0-.5.5v1a.5.5 0 0 0 .5.5h1a.5.5 0 0 0 .5-.5v-1a.5.5 0 0 0-.5-.5h-1zM4 12.5v1a.5.5 0 0 0 .5.5h1a.5.5 0 0 0 .5-.5v-1a.5.5 0 0 0-.5-.5h-1a.5.5 0 0 0-.5.5zM7.5 6a.5.5 0 0 0-.5.5v1a.5.5 0 0 0 .5.5h1a.5.5 0 0 0 .5-.5v-1a.5.5 0 0 0-.5-.5h-1zM7 9.5v1a.5.5 0 0 0 .5.5h1a.5.5 0 0 0 .5-.5v-1a.5.5 0 0 0-.5-.5h-1a.5.5 0 0 0-.5.5zm.5 2.5a.5.5 0 0 0-.5.5v1a.5.5 0 0 0 .5.5h1a.5.5 0 0 0 .5-.5v-1a.5.5 0 0 0-.5-.5h-1zM10 6.5v1a.5.5 0 0 0 .5.5h1a.5.5 0 0 0 .5-.5v-1a.5.5 0 0 0-.5-.5h-1a.5.5 0 0 0-.5.5zm.5 2.5a.5.5 0 0 0-.5.5v4a.5.5 0 0 0 .5.5h1a.5.5 0 0 0 .5-.5v-4a.5.5 0 0 0-.5-.5h-1z"/> + </svg> Expense Tracker</a> + </li> + <li class="nav-item"> + <a class="nav-link" {% if request.path == '/history' %}id="active-nav"{% endif %} href="/history"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-journal-text" viewBox="0 0 16 16"> + <path d="M5 10.5a.5.5 0 0 1 .5-.5h2a.5.5 0 0 1 0 1h-2a.5.5 0 0 1-.5-.5zm0-2a.5.5 0 0 1 .5-.5h5a.5.5 0 0 1 0 1h-5a.5.5 0 0 1-.5-.5zm0-2a.5.5 0 0 1 .5-.5h5a.5.5 0 0 1 0 1h-5a.5.5 0 0 1-.5-.5zm0-2a.5.5 0 0 1 .5-.5h5a.5.5 0 0 1 0 1h-5a.5.5 0 0 1-.5-.5z"/> + <path d="M3 0h10a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2H3a2 2 0 0 1-2-2v-1h1v1a1 1 0 0 0 1 1h10a1 1 0 0 0 1-1V2a1 1 0 0 0-1-1H3a1 1 0 0 0-1 1v1H1V2a2 2 0 0 1 2-2z"/> + <path d="M1 5v-.5a.5.5 0 0 1 1 0V5h.5a.5.5 0 0 1 0 1h-2a.5.5 0 0 1 0-1H1zm0 3v-.5a.5.5 0 0 1 1 0V8h.5a.5.5 0 0 1 0 1h-2a.5.5 0 0 1 0-1H1zm0 3v-.5a.5.5 0 0 1 1 0v.5h.5a.5.5 0 0 1 0 1h-2a.5.5 0 0 1 0-1H1z"/> + </svg> Spending History</a> + </li> + <li class="nav-item"> + <a class="nav-link" {% if request.path == '/bargain' %}id="active-nav"{% endif %} href="/bargain"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-cash-coin" viewBox="0 0 16 16"> + <path fill-rule="evenodd" d="M11 15a4 4 0 1 0 0-8 4 4 0 0 0 0 8zm5-4a5 5 0 1 1-10 0 5 5 0 0 1 10 0z"/> + <path d="M9.438 11.944c.047.596.518 1.06 1.363 1.116v.44h.375v-.443c.875-.061 1.386-.529 1.386-1.207 0-.618-.39-.936-1.09-1.1l-.296-.07v-1.2c.376.043.614.248.671.532h.658c-.047-.575-.54-1.024-1.329-1.073V8.5h-.375v.45c-.747.073-1.255.522-1.255 1.158 0 .562.378.92 1.007 1.066l.248.061v1.272c-.384-.058-.639-.27-.696-.563h-.668zm1.36-1.354c-.369-.085-.569-.26-.569-.522 0-.294.216-.514.572-.578v1.1h-.003zm.432.746c.449.104.655.272.655.569 0 .339-.257.571-.709.614v-1.195l.054.012z"/> + <path d="M1 0a1 1 0 0 0-1 1v8a1 1 0 0 0 1 1h4.083c.058-.344.145-.678.258-1H3a2 2 0 0 0-2-2V3a2 2 0 0 0 2-2h10a2 2 0 0 0 2 2v3.528c.38.34.717.728 1 1.154V1a1 1 0 0 0-1-1H1z"/> + <path d="M9.998 5.083 10 5a2 2 0 1 0-3.132 1.65 5.982 5.982 0 0 1 3.13-1.567z"/> + </svg> Bargain Finder</a> + </li> + </ul> + <!-- nav tabs on the right for logged-in user --> + <ul class="navbar-nav ms-auto mt-2"> + <li class="nav-item"> + <a class="nav-link" {% if request.path == '/account' %}id="active-nav"{% endif %} href="/account"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-person-circle" viewBox="0 0 16 16"> + <path d="M11 6a3 3 0 1 1-6 0 3 3 0 0 1 6 0z"/> + <path fill-rule="evenodd" d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8zm8-7a7 7 0 0 0-5.468 11.37C3.242 11.226 4.805 10 8 10s4.757 1.225 5.468 2.37A7 7 0 0 0 8 1z"/> + </svg> Account</a> + </li> + <li class="nav-item"> + <a class="nav-link" href="/logout"> + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-power" viewBox="0 0 16 16"> + <path d="M7.5 1v7h1V1h-1z"/> + <path d="M3 8.812a4.999 4.999 0 0 1 2.578-4.375l-.485-.874A6 6 0 1 0 11 3.616l-.501.865A5 5 0 1 1 3 8.812z"/> + </svg> Log Out</a> + </li> + </ul> + + <!-- Nav tabs on the right for visting guest --> + {% else %} + <ul class="navbar-nav ms-auto mt-2"> + <li class="nav-item"><a class="nav-link" {% if request.path == '/register' %}id="active-nav"{% endif %} href="/register">Register</a></li> + <li class="nav-item"><a class="nav-link" {% if request.path == '/login' %}id="active-nav"{% endif %} href="/login">Log In</a></li> + </ul> + {% endif %} + </div> + </nav> + + {% if get_flashed_messages() %} + <header> + <div class="alert alert-warning border text-center" role="alert"> + {{ get_flashed_messages() | join(" ") }} + </div> + </header> + {% endif %} + + <main class="container p-5"> + {% block main %}{% endblock %} + </main> + + <footer class="small text-center text-muted"> + <p><i>Feel free to <a href="https://www.youtube.com/watch?v=dQw4w9WgXcQ" class="link-success" target="_blank">contact us</a> anytime if you have questions or feedback!</i></p> + </footer> + </body> +</html> diff --git a/templates/login.html b/templates/login.html new file mode 100644 index 0000000..52d453a --- /dev/null +++ b/templates/login.html @@ -0,0 +1,19 @@ +{% extends "layout.html" %} + +{% block title %} + Log In +{% endblock %} + +{% block main %} + <form action="/login" method="post"> + <div class="mb-3"> + <input autocomplete="off" autocomplete="off" autofocus class="form-control" name="username" placeholder="Username" type="text"> + </div> + <div class="mb-3"> + <input class="form-control" autocomplete="off" name="password" placeholder="Password" type="password"> + </div> + <button class="btn btn-success" type="submit">Log In</button> + </form> + <br> + <p>New here? <a href="/register" class="link-success">Register</a> for a free account!</p> +{% endblock %}
\ No newline at end of file diff --git a/templates/register.html b/templates/register.html new file mode 100644 index 0000000..e7d105e --- /dev/null +++ b/templates/register.html @@ -0,0 +1,25 @@ +{% extends "layout.html" %} + +{% block title %} + Register +{% endblock %} + +{% block main %} + <form action="/register" method="post"> + <div class="form-group"> + <input autocomplete="off" autocomplete="off" autofocus class="form-control" name="username" placeholder="Username" type="text"> + </div> + <br> + <div class="form-group"> + <input class="form-control" autocomplete="off" name="password" placeholder="Password" type="password"> + <p class="footnote">* Password must be between 6-25 characters long and contain at least one number and one letter</p> + </div> + <div class="form-group"> + <input class="form-control" autocomplete="off" name="confirmation" placeholder="Confirm Password" type="password"> + <p class="footnote">* Your input must match the password above</p> + </div> + <button class="btn btn-success" type="submit">Register</button> + </form> + <br> + <p>You already have an account? <a href="/login" class="link-success">Sign in!</a></p> +{% endblock %} diff --git a/templates/tracker.html b/templates/tracker.html new file mode 100644 index 0000000..f0edfb8 --- /dev/null +++ b/templates/tracker.html @@ -0,0 +1,74 @@ +{% extends "layout.html" %} + +{% block title %} + Expense Tracker +{% endblock %} + +{% block main %} + <!-- Register the specifics of a new expense --> + <form action="/tracker" method="post"> + <div class="form-group"> + <label for="comment"><b>Specify the expense</b> (optional)</label><br> + <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="currentColor" class="bi bi-cart-check" viewBox="0 0 16 16"> + <path d="M11.354 6.354a.5.5 0 0 0-.708-.708L8 8.293 6.854 7.146a.5.5 0 1 0-.708.708l1.5 1.5a.5.5 0 0 0 .708 0l3-3z"/> + <path d="M.5 1a.5.5 0 0 0 0 1h1.11l.401 1.607 1.498 7.985A.5.5 0 0 0 4 12h1a2 2 0 1 0 0 4 2 2 0 0 0 0-4h7a2 2 0 1 0 0 4 2 2 0 0 0 0-4h1a.5.5 0 0 0 .491-.408l1.5-8A.5.5 0 0 0 14.5 3H2.89l-.405-1.621A.5.5 0 0 0 2 1H.5zm3.915 10L3.102 4h10.796l-1.313 7h-8.17zM6 14a1 1 0 1 1-2 0 1 1 0 0 1 2 0zm7 0a1 1 0 1 1-2 0 1 1 0 0 1 2 0z"/> + </svg> + <input autocomplete="off" autofocus class="form-control" name="comment" placeholder="Unspecified" type="text"> + </div> + <br> + + <div class="form-group"> + <label for="amount"><b>Amount</b></label><br> + <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="currentColor" class="bi bi-coin" viewBox="0 0 16 16"> + <path d="M5.5 9.511c.076.954.83 1.697 2.182 1.785V12h.6v-.709c1.4-.098 2.218-.846 2.218-1.932 0-.987-.626-1.496-1.745-1.76l-.473-.112V5.57c.6.068.982.396 1.074.85h1.052c-.076-.919-.864-1.638-2.126-1.716V4h-.6v.719c-1.195.117-2.01.836-2.01 1.853 0 .9.606 1.472 1.613 1.707l.397.098v2.034c-.615-.093-1.022-.43-1.114-.9H5.5zm2.177-2.166c-.59-.137-.91-.416-.91-.836 0-.47.345-.822.915-.925v1.76h-.005zm.692 1.193c.717.166 1.048.435 1.048.91 0 .542-.412.914-1.135.982V8.518l.087.02z"/> + <path d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z"/> + <path d="M8 13.5a5.5 5.5 0 1 1 0-11 5.5 5.5 0 0 1 0 11zm0 .5A6 6 0 1 0 8 2a6 6 0 0 0 0 12z"/> + </svg> + <input autocomplete="off" class="form-control" name="amount" placeholder="1.00" type="number" min="1.00" step="0.01" required><br> + <p class="footnote">* Must be at least $1.00</p> + </div> + <br> + + <div class="form-group"> + <label for="date"><b>Date</b></label><br> + <svg xmlns="http://www.w3.org/2000/svg" width="22" height="22" fill="currentColor" class="bi bi-calendar3" viewBox="0 0 16 16"> + <path d="M14 0H2a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V2a2 2 0 0 0-2-2zM1 3.857C1 3.384 1.448 3 2 3h12c.552 0 1 .384 1 .857v10.286c0 .473-.448.857-1 .857H2c-.552 0-1-.384-1-.857V3.857z"/> + <path d="M6.5 7a1 1 0 1 0 0-2 1 1 0 0 0 0 2zm3 0a1 1 0 1 0 0-2 1 1 0 0 0 0 2zm3 0a1 1 0 1 0 0-2 1 1 0 0 0 0 2zm-9 3a1 1 0 1 0 0-2 1 1 0 0 0 0 2zm3 0a1 1 0 1 0 0-2 1 1 0 0 0 0 2zm3 0a1 1 0 1 0 0-2 1 1 0 0 0 0 2zm3 0a1 1 0 1 0 0-2 1 1 0 0 0 0 2zm-9 3a1 1 0 1 0 0-2 1 1 0 0 0 0 2zm3 0a1 1 0 1 0 0-2 1 1 0 0 0 0 2zm3 0a1 1 0 1 0 0-2 1 1 0 0 0 0 2z"/> + </svg> + <input type="date" name="date" required> + </div> + <br> + + <div class="form-group"> + <!-- "name" must be identical for group if only one option should be selectable; different names = all selecatble! --> + <label for="category"><b>Category</b></label><br> + <input type="radio" id="rent" name="category" value="🏠 Rent"> + <label for="rent"><span class="text">🏠 Rent & Bills</span></label><br> + + <input type="radio" id="maintenance" name="category" value="🛠 Maintenance"> + <label for="maintenance"><span class="text">🛠 Maintenance</span></label><br> + + <input type="radio" id="food" name="category" value="🥪 Food"> + <label for="food"><span class="text">🥪 Food</span></label><br> + + <input type="radio" id="family" name="category" value="👪 Family"> + <label for="family"><span class="text">👪 Family</span></label><br> + + <input type="radio" id="pets" name="category" value="🐇 Pets"> + <label for="pets"><span class="text">🐇 Pets</span></label><br> + + <input type="radio" id="clothes" name="category" value="👕 Clothes"> + <label for="clothes"><span class="text">👕 Clothes</span></label><br> + + <input type="radio" id="hobbies" name="category" value="🏈 Hobbies"> + <label for="hobbies"><span class="text">🏈 Hobbies & Entertainment</span></label><br> + + <input type="radio" id="investing" name="category" value="📈 Investing"> + <label for="investing"><span class="text">📈 Investing</span></label><br> + + <input type="radio" id="other" name="category" value="❓ Other" checked> + <label for="other"><span class="text">❓ Other/Unspecified</span></label><br> + </div><br> + <button class="btn btn-success" type="submit">Submit</button> + </form> +{% endblock %} diff --git a/templates/welcome.html b/templates/welcome.html new file mode 100644 index 0000000..86f4ac6 --- /dev/null +++ b/templates/welcome.html @@ -0,0 +1,86 @@ +{% extends "layout.html" %} + +{% block title %} + Welcome +{% endblock %} + +{% block main %} +<section> + <h1 id="header-main">Welcome to Total Expense!</h1><br> + <h3>Your personal money saving assistant</h3><br> +</section> + +<section> + <div id="CarouselWelcome" class="carousel carousel-dark slide" data-bs-ride="carousel"> + <div class="carousel-indicators"> + <button type="button" data-bs-target="#CarouselWelcome" data-bs-slide-to="0" class="active" aria-current="true" aria-label="Slide 1"></button> + <button type="button" data-bs-target="#CarouselWelcome" data-bs-slide-to="1" aria-label="Slide 2"></button> + <button type="button" data-bs-target="#CarouselWelcome" data-bs-slide-to="2" aria-label="Slide 3"></button> + <button type="button" data-bs-target="#CarouselWelcome" data-bs-slide-to="3" aria-label="Slide 4"></button> + </div> + <div class="carousel-inner"> + <div class="carousel-item active" data-bs-interval="5000"> + <img src="/static/couple_piggy.png" class="border border-secondary rounded" alt="..."> + <div class="carousel-caption d-none d-md-block"> + <h5 style="color: #910700;">Take charge of your savings with our digital financial helper!</h5> + <p style="color: #910700;" class="carousel-text">Create an account today and leave debts behind forever.</p> + </div> + </div> + <div class="carousel-item" data-bs-interval="5000"> + <img src="/static/happy_piggy.png" class="border border-secondary rounded carousel-img" alt="..."> + <div class="carousel-caption d-none d-md-block"> + <h5 style="color: #15627d;">Keep your piggy bank - and yourself - happy!</h5> + <p style="color: #15627d" class="carousel-text">Even small change can make a big change.</p> + </div> + </div> + <div class="carousel-item" data-bs-interval="5000"> + <img src="/static/piggy_categories.png" class="border border-secondary rounded carousel-img" alt="..."> + <div class="carousel-caption d-none d-md-block"> + <h5 style="color: white;">Use personalized spending categories!</h5> + <p style="color: white;" class="carousel-text">Keep detailed track of your individual spending habits.</p> + </div> + </div> + <div class="carousel-item" data-bs-interval="5000"> + <img src="/static/piggy_house.png" class="border border-secondary rounded carousel-img" alt="..."> + <div class="carousel-caption d-none d-md-block"> + <h5 style="color: #fae682;">Fulfill your dreams!</h5> + <p style="color: #fae682;" class="carousel-text">Start saving today and achieve your financial goals tomorrow.</p> + </div> + </div> + </div> + <button class="carousel-control-prev" type="button" data-bs-target="#CarouselWelcome" data-bs-slide="prev"> + <span class="carousel-control-prev-icon" aria-hidden="true"></span> + <span class="visually-hidden">Previous</span> + </button> + <button class="carousel-control-next" type="button" data-bs-target="#CarouselWelcome" data-bs-slide="next"> + <span class="carousel-control-next-icon" aria-hidden="true"></span> + <span class="visually-hidden">Next</span> + </button> + </div> +</section> + +<section> + <div class="row align-items-start row-cols-2" style="margin-top: 60px;"> + <div class="col card border-dark mb-3" style="background-color: #d1e7dd;"> + <article id="text-welcome"> + <p style="margin-top: 10px;">Are you tired of relying on financial experts? You do not know how to finance your big dreams but you want to make a change?<br></p> + <p>Then you have come to the right place: here you can easily keep track of your spending habits and monitor your individual budget.<br></p> + <p>And a special highlight to meet your online shopping needs: we will help you to find the best deals!<br></p> + <p>This way you will never run the risk of spending more than you can afford.<br></p> + <p>Instead, you can build financial funds step by step, coming closer to fulfilling your dreams!<br></p> + <p>So what are you waiting for? Sign up today and create your account! It is <u>totally free</u>!</p> + </article> + </div> + + <div class="col card border-dark mb-3" style="background-color: #d1e7dd; margin-top: 50px;"> + <ul> + <li class="text-bullet">Create a free account!</li> + <li class="text-bullet">Set your personal budget!</li> + <li class="text-bullet">Track your every expense!</li> + <li class="text-bullet">Review your spending history in detail!</li> + <li class="text-bullet">Find the cheapest online deals!</li> + </ul> + </div> + </div> +</section> +{% endblock %} |
