Update README and description, add license

Closes #15

LICENSE

@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are 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.
+
+  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.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  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 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 work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero 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 Affero 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 Affero 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 Affero 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) 2023  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  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 AGPL, see
+<https://www.gnu.org/licenses/>.

README.md

@@ -3,3 +3,28 @@
 Modern Flutter based Android client for [Fever](https://freshrss.github.io/FreshRSS/en/developers/06_Fever_API.html) compatible news sources using Material 3.
 
 This application is mainly intended as a client for [FreshRSS](https://github.com/freshrss/freshrss). It conforms to the Fever API specification, but compatibility with other implementations is not guaranteed.
+
+## Download
+
+Feet is hosted on my [personal F-Droid repo](https://droid.lea.pet). You can also download the APK directly [here](https://droid.lea.pet/feet.apk).
+
+Before setting up a Fever compatible news source, you can connect to a demo server from within the app to try it out.
+
+## Building
+
+Follow [the instructions](https://docs.flutter.dev/get-started/install) to install Flutter.
+**Stay away from the snap package!** If you're on Arch, you can get Flutter from the AUR. On other distros, follow the manual installation steps.
+
+After cloning the repository, run `flutter pub get` to fetch dependencies, then run `flutter build apk`.
+If your phone is connected via ADB, you can directly install the APK using `flutter install`.
+
+Note that while Flutter offers cross-platform support, I only develop for Android and other targets (including desktop builds) most likely won't work.
+If you plan on contributing you should develop on a real phone or an Android emulator.
+
+## Screenshots
+
+<img src="assets/home.png" height="500" /> <img src="assets/post.png" height="500" />
+
+### Notifications
+
+<img src="assets/notif.png" height="500" />

analysis_options.yaml

@@ -22,7 +22,7 @@ linter:
   # `// ignore_for_file: name_of_lint` syntax on the line or in the file
   # producing the lint.
   rules:
-    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    avoid_print: false
     # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
 
 # Additional information about this file can be found at

android/app/src/main/AndroidManifest.xml

@@ -13,7 +13,7 @@
       </intent>
     </queries>
     <application
-        android:label="feet"
+        android:label="Feet"
         android:name="${applicationName}"
         android:icon="@mipmap/ic_launcher">
         <activity

android/app/src/main/res/drawable/ic_launcher_foreground.xml

@@ -0,0 +1,12 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="108dp"
+    android:height="108dp"
+    android:viewportWidth="108"
+    android:viewportHeight="108">
+  <group android:scaleX="0.84144914"
+      android:scaleY="0.84144914">
+    <path
+        android:pathData="M65.83,85.68V79.06h9.92L87.49,62.52 75.75,45.98H42.67V55.9H36.06V39.37H79.22L95.6,62.52 79.22,85.68ZM42.67,88.98V79.06H32.75V72.44h9.92V62.52h6.62v9.92h9.92v6.62H49.29v9.92Z"
+        android:fillColor="#3e71ff"/>
+  </group>
+</vector>

android/app/src/main/res/drawable/notification_icon.xml

@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="128.35dp"
+    android:height="128.35dp"
+    android:viewportWidth="128.35"
+    android:viewportHeight="128.35">
+  <path
+      android:pathData="M67.54,107.92L67.54,94.46h20.19l23.89,-33.65 -23.89,-33.65h-67.3L20.43,47.34L6.97,47.34L6.97,13.7L94.79,13.7L128.11,60.81 94.79,107.92ZM20.43,114.65L20.43,94.46L0.24,94.46L0.24,81L20.43,81L20.43,60.81L33.89,60.81L33.89,81L54.08,81L54.08,94.46L33.89,94.46v20.19z"
+      android:strokeWidth="2.03462"
+      android:fillColor="#3e71ff"/>
+</vector>

android/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
+    <background android:drawable="@color/ic_launcher_background"/>
+    <foreground android:drawable="@drawable/ic_launcher_foreground"/>
+</adaptive-icon>

android/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
+    <background android:drawable="@color/ic_launcher_background"/>
+    <foreground android:drawable="@drawable/ic_launcher_foreground"/>
+</adaptive-icon>

android/app/src/main/res/values/ic_launcher_background.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <color name="ic_launcher_background">#222227</color>
+</resources>

assets/icon/icon.svg

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   viewBox="0 0 128.348 128.348"
+   version="1.1"
+   id="svg10"
+   sodipodi:docname="icon.svg"
+   inkscape:version="1.2.2 (b0a8486541, 2022-12-01)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview12"
+     pagecolor="#505050"
+     bordercolor="#ffffff"
+     borderopacity="1"
+     inkscape:showpageshadow="0"
+     inkscape:pageopacity="0"
+     inkscape:pagecheckerboard="1"
+     inkscape:deskcolor="#505050"
+     showgrid="false"
+     inkscape:zoom="6.6537846"
+     inkscape:cx="64.174004"
+     inkscape:cy="64.174004"
+     inkscape:window-width="1920"
+     inkscape:window-height="1051"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg10" />
+  <defs
+     id="defs4">
+    <style
+       id="style2">.a{fill:#222227;}.b{fill:#3e71ff;}</style>
+  </defs>
+  <path
+     class="b"
+     d="M65.828,85.675V79.059h9.923L87.494,62.52,75.751,45.981H42.673V55.9H36.057V39.365H79.224L95.6,62.52,79.224,85.675ZM42.673,88.983V79.059H32.75V72.443h9.923V62.52h6.616v9.923h9.923v6.616H49.289v9.924Z"
+     id="path8" />
+</svg>

assets/icon/icon1.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128.348 128.348"><defs><style>.a{fill:#222227;}.b{fill:#3e71ff;}</style></defs><rect class="a" width="128.348" height="128.348" rx="22.257"/><path class="b" d="M65.828,85.675V79.059h9.923L87.494,62.52,75.751,45.981H42.673V55.9H36.057V39.365H79.224L95.6,62.52,79.224,85.675ZM42.673,88.983V79.059H32.75V72.443h9.923V62.52h6.616v9.923h9.923v6.616H49.289v9.924Z"/></svg>

assets/icon/icon2.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128.348 128.348"><defs><style>.a{fill:#212320;}.b{fill:#76ff43;}</style></defs><rect class="a" width="128.348" height="128.348" rx="22.844"/><path class="b" d="M65.828,85.675V79.059h9.923L87.494,62.52,75.751,45.981H42.673V55.9H36.057V39.365H79.224L95.6,62.52,79.224,85.675ZM42.673,88.983V79.059H32.75V72.443h9.923V62.52h6.616v9.923h9.923v6.616H49.289v9.924Z"/></svg>

assets/icon/icon3.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128.348 128.348"><defs><style>.a{fill:#262223;}.b{fill:#ff40a4;}</style></defs><rect class="a" width="128.348" height="128.348" rx="22.192"/><path class="b" d="M65.828,85.675V79.059h9.923L87.494,62.52,75.751,45.981H42.673V55.9H36.057V39.365H79.224L95.6,62.52,79.224,85.675ZM42.673,88.983V79.059H32.75V72.443h9.923V62.52h6.616v9.923h9.923v6.616H49.289v9.924Z"/></svg>

assets/icon/icon_big.svg

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   viewBox="0 0 128.348 128.348"
+   version="1.1"
+   id="svg10"
+   sodipodi:docname="icon_big.svg"
+   inkscape:version="1.2.2 (b0a8486541, 2022-12-01)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview12"
+     pagecolor="#505050"
+     bordercolor="#ffffff"
+     borderopacity="1"
+     inkscape:showpageshadow="0"
+     inkscape:pageopacity="0"
+     inkscape:pagecheckerboard="1"
+     inkscape:deskcolor="#505050"
+     showgrid="false"
+     inkscape:zoom="6.6537846"
+     inkscape:cx="64.174004"
+     inkscape:cy="64.174004"
+     inkscape:window-width="1920"
+     inkscape:window-height="1051"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg10" />
+  <defs
+     id="defs4">
+    <style
+       id="style2">.a{fill:#222227;}.b{fill:#3e71ff;}</style>
+  </defs>
+  <path
+     class="b"
+     d="M 67.538219,107.92026 V 94.459247 h 20.189486 l 23.892485,-33.6505 -23.892485,-33.6505 h -67.301 V 47.339594 H 6.9656912 V 13.697233 H 94.793923 L 128.11278,60.808747 94.793923,107.92026 Z m -47.111514,6.73051 V 94.459247 H 0.23721886 V 80.998233 H 20.426705 V 60.808747 H 33.887719 V 80.998233 H 54.077205 V 94.459247 H 33.887719 v 20.191523 z"
+     id="path8"
+     style="stroke-width:2.03462" />
+</svg>

lib/api/api.dart

@@ -141,6 +141,11 @@ class APIRequestBuilder {
     return this;
   }
 
+  APIRequestBuilder withIds(List<int> ids) {
+    _addArg('with_ids=${ids.join(',')}');
+    return this;
+  }
+
   /// Executes the API request and returns the JSON data
   Future<Map<String, dynamic>> fetch() async {
     if (api.apiKey == null || api.apiUrl == null) {

lib/api/cache.dart

@@ -52,8 +52,9 @@ class ObjectCache<K, T> {
 class ItemCache extends ObjectCache<int, Item> {
   /// Get all items for a given feed
   List<Item> getForFeed(int feed) {
-    if (api.cache.feeds.get(feed) == null)
+    if (api.cache.feeds.get(feed) == null) {
       throw Exception('Feed $feed doesn\'t exist');
+    }
     return _items.values.where((item) => item.feedId == feed).toList();
   }
 

lib/main.dart

@@ -1,6 +1,7 @@
 import 'dart:async';
 
 import 'package:feet/notifications/tasks.dart';
+import 'package:feet/util.dart';
 import 'package:feet/widgets/centered_page_hint.dart';
 import 'package:feet/widgets/filter_menu.dart';
 import 'package:feet/widgets/homepage_post.dart';
@@ -13,18 +14,26 @@ import 'api/api.dart';
 
 // Limit the maximum amount of posts to fetch so we don't wait forever when
 // fetching a large list
-const FETCH_MAX_POSTS = 1000;
+const fetchMaxPosts = 1000;
+
+// Store these globally so our notification handler can access them
+BuildContext? globalContext;
+final api = FeverAPI();
 
 void main() {
   setupBackgroundTasks();
-  runApp(MyApp());
+  runApp(const MyApp());
 }
 
-class MyApp extends StatelessWidget {
+class MyApp extends StatefulWidget {
-  final api = FeverAPI();
+  const MyApp({super.key});
-  SharedPreferences? prefs;
 
-  MyApp({super.key});
+  @override
+  State<MyApp> createState() => _MyAppState();
+}
+
+class _MyAppState extends State<MyApp> {
+  SharedPreferences? prefs;
 
   Future<bool> _loadPrefs() async {
     var prefs = await SharedPreferences.getInstance();
@@ -59,6 +68,7 @@ class MyApp extends StatelessWidget {
             themeMode: ThemeMode.system,
             home: FutureBuilder<bool>(
               builder: (context, snapshot) {
+                globalContext = context;
                 if (snapshot.hasData && prefs != null) {
                   return MyHomePage(title: 'Feet', api: api, prefs: prefs!);
                 }
@@ -82,66 +92,107 @@ class MyHomePage extends StatefulWidget {
   State<MyHomePage> createState() => _MyHomePageState();
 }
 
-class _MyHomePageState extends State<MyHomePage> {
+class _MyHomePageState extends State<MyHomePage> with WidgetsBindingObserver {
   var _index = 0;
   var _fetched = false;
   var _fetchedCount = 0;
   var _knownPostsSize = -1;
+  var _isDemoUser = false;
+  AppLifecycleState? _appState;
   List<int> _feedFilter = [];
 
-  Future<void> refresh() async {
+  @override
-    widget.api.cache.clear();
+  void didChangeAppLifecycleState(AppLifecycleState state) {
+    print("Lifecycle state changed from $_appState to $state");
+
+    if (_appState != state) {
+      if (state == AppLifecycleState.resumed) {
+        refresh(fullRefresh: false);
+      }
+    }
+
     setState(() {
-      _fetchedCount = 0;
+      _appState = state;
-      _knownPostsSize = -1;
+    });
-      _feedFilter = [];
+  }
+
+  @override
+  void initState() {
+    super.initState();
+
+    WidgetsBinding.instance.addObserver(this);
+
+    setState(() {
+      print("Demo: ${widget.prefs.getBool("isDemo")}");
+      _isDemoUser = widget.prefs.getBool("isDemo") ?? false;
     });
 
+    refresh(fullRefresh: true).then((_) => setState(() {
+      _fetched = true;
+    }));
+  }
+
+  @override
+  void dispose() {
+    super.dispose();
+    WidgetsBinding.instance.removeObserver(this);
+  }
+
+  Future<void> refresh({ required bool fullRefresh }) async {
     print("Starting refresh");
 
+    listIds() => widget.api.cache.items
+      .getAll()
+      .values
+      .map((value) => value.id)
+      .toList()
+      ..sort((a, b) => b - a);
+
+    if (fullRefresh) {
+      widget.api.cache.clear();
+      setState(() {
+        _fetchedCount = 0;
+        _knownPostsSize = -1;
+        _feedFilter = [];
+      });
+    }
+
     var data = await widget.api
         .request()
         .withFeeds()
         .withGroups()
         .withFavicons()
         .withItems()
-        .sinceId(0)
+        .sinceId(fullRefresh ? 0 : listIds().first)
         .execute();
 
     while ((data['items'] as List<dynamic>).isNotEmpty &&
-        _fetchedCount < FETCH_MAX_POSTS) {
+        _fetchedCount < fetchMaxPosts) {
       print("Fetching more items");
 
-      var ids = widget.api.cache.items
+      var ids = listIds();
-          .getAll()
-          .values
-          .map((value) => value.id)
-          .toList()
-        ..sort((a, b) => b - a);
 
       setState(() {
         _fetchedCount = ids.length;
         _knownPostsSize = data['total_items'] ?? -1;
       });
 
-      data =
+      data = await widget.api.request().withItems().sinceId(ids.first).execute();
-          await widget.api.request().withItems().sinceId(ids.first).execute();
 
       print(
           "Item cache size is now ${widget.api.cache.items.size} ${ids.first} ${ids.last}");
     }
   }
 
-  @override
-  void initState() {
-    super.initState();
-    refresh().then((_) => setState(() {
-          _fetched = true;
-        }));
-  }
-
   @override
   Widget build(BuildContext context) {
+    var isDemo = widget.prefs.getBool("isDemo");
+    if (isDemo != _isDemoUser) {
+      setState(() {
+        _isDemoUser = isDemo ?? false;
+      });
+    }
+
     var loggedIn = widget.api.loggedIn();
     var posts = widget.api.cache.items.getAll().values.where((element) =>
         _feedFilter.isEmpty || _feedFilter.contains(element.feedId));
@@ -194,7 +245,7 @@ class _MyHomePageState extends State<MyHomePage> {
 
         if (loggedIn) {
           timer.cancel();
-          refresh().then((_) => setState(() => _fetched = true));
+          refresh(fullRefresh: true).then((_) => setState(() => _fetched = true));
         }
       });
     }
@@ -202,91 +253,145 @@ class _MyHomePageState extends State<MyHomePage> {
     return Scaffold(
       appBar: AppBar(
         title: Text(widget.title),
-        actions: [
+        actions: loggedIn
-          IconButton(
+            ? [
-            onPressed: () {
+                _isDemoUser
-              var theme = Theme.of(context);
+                    ? ElevatedButton(
-
+                        onPressed: () {
-              HapticFeedback.heavyImpact();
+                          showDialog(
-              ScaffoldMessenger.of(context).showSnackBar(
-                SnackBar(
-                  content: Text('Refreshing feeds',
-                      style: TextStyle(color: theme.colorScheme.onBackground)),
-                  duration: const Duration(seconds: 2),
-                  backgroundColor: theme.colorScheme.secondaryContainer,
-                ),
-              );
-              refresh().then((_) {
-                setState(() {});
-              });
-            },
-            icon: const Icon(Icons.replay_outlined),
-          ), // Refresh
-          PopupMenuButton(
-              itemBuilder: (context) => [
-                    PopupMenuItem(
-                      value: "log_out",
-                      child: const Text("Log out"),
-                      onTap: () {
-                        Future.delayed(
-                          const Duration(seconds: 0),
-                          () => showDialog(
                             context: context,
                             builder: (context) => AlertDialog(
-                              title: const Text("Log out"),
+                              title: const Text("Connected to demo server"),
-                              content: const Text(
+                              content: RichText(
-                                  "Are you sure you want to log out?"),
+                                  text: TextSpan(
+                                children: [
+                                  const TextSpan(
+                                      text:
+                                          "You are currently connected to the demo server.\n"
+                                          "Use the"),
+                                  WidgetSpan(
+                                    child: Icon(Icons.adaptive.more, size: 20),
+                                  ),
+                                  const TextSpan(
+                                      text:
+                                          "button in the top right to log out and switch "
+                                          "to your own instance once you're done exploring."),
+                                ],
+                              )),
                               actions: [
                                 TextButton(
-                                    onPressed: () async {
+                                  onPressed: () => Navigator.of(context).pop(),
-                                      Navigator.pop(context);
+                                  child: const Text("Got it!"),
-                                      await widget.prefs.clear();
-
-                                      setState(() {
-                                        widget.api.apiKey = null;
-                                        widget.api.apiUrl = null;
-                                        widget.api.cache.clear();
-                                      });
-                                    },
-                                    child: const Text("Do it!")),
-                                TextButton(
-                                  onPressed: () {
-                                    Navigator.pop(context);
-                                  },
-                                  child: const Text("Nevermind"),
                                 ),
                               ],
                             ),
+                          );
+                        },
+                        style: ElevatedButton.styleFrom(
+                          backgroundColor:
+                              const Color.fromARGB(255, 114, 77, 7),
+                          foregroundColor: Colors.amber,
+                        ),
+                        child: Row(children: const [
+                          Icon(Icons.warning),
+                          SizedBox(width: 8),
+                          Text("Demo"),
+                        ]))
+                    : Container(),
+                IconButton(
+                  onPressed: () {
+                    var theme = Theme.of(context);
+
+                    HapticFeedback.heavyImpact();
+                    ScaffoldMessenger.of(context).showSnackBar(
+                      SnackBar(
+                        content: Text('Refreshing feeds',
+                            style: TextStyle(
+                                color: theme.colorScheme.onBackground)),
+                        duration: const Duration(seconds: 2),
+                        backgroundColor: theme.colorScheme.secondaryContainer,
+                      ),
+                    );
+                    refresh(fullRefresh: false).then((_) {
+                      setState(() {});
+                    });
+                  },
+                  icon: const Icon(Icons.replay_outlined),
+                ), // Refresh
+                PopupMenuButton(
+                    itemBuilder: (context) => [
+                          PopupMenuItem(
+                            value: "log_out",
+                            child: const Text("Log out"),
+                            onTap: () {
+                              Future.delayed(
+                                const Duration(seconds: 0),
+                                () => showDialog(
+                                  context: context,
+                                  builder: (context) => AlertDialog(
+                                    title: const Text("Log out"),
+                                    content: const Text(
+                                        "Are you sure you want to log out?"),
+                                    actions: [
+                                      TextButton(
+                                        onPressed: () {
+                                          Navigator.pop(context);
+                                        },
+                                        child: const Text("Nevermind"),
+                                      ),
+                                      TextButton(
+                                          onPressed: () async {
+                                            Navigator.pop(context);
+                                            await widget.prefs.clear();
+
+                                            setState(() {
+                                              widget.api.apiKey = null;
+                                              widget.api.apiUrl = null;
+                                              widget.api.cache.clear();
+                                            });
+                                          },
+                                          child: const Text("Do it!")),
+                                    ],
+                                  ),
+                                ),
+                              );
+                            },
                           ),
-                        );
+                          PopupMenuItem(
-                      },
+                            value: "filter",
-                    ),
+                            child: Text(_feedFilter.isEmpty
-                    PopupMenuItem(
+                                ? "Filter..."
-                      value: "filter",
+                                : "Filter (${_feedFilter.length}/${widget.api.cache.feeds.size})"),
-                      child: Text(_feedFilter.isEmpty
+                            onTap: () {
-                          ? "Filter..."
+                              Future.delayed(
-                          : "Filter (${_feedFilter.length}/${widget.api.cache.feeds.size})"),
+                                Duration.zero,
-                      onTap: () {
+                                () => showDialog(
-                        Future.delayed(
+                                  context: context,
-                          Duration.zero,
+                                  barrierDismissible: false,
-                          () => showDialog(
+                                  builder: (context) => FilterMenu(
-                            context: context,
+                                    api: widget.api,
-                            barrierDismissible: false,
+                                    initData: _feedFilter,
-                            builder: (context) => FilterMenu(
+                                    onConfirm: (items) {
-                              api: widget.api,
+                                      setState(() {
-                              initData: _feedFilter,
+                                        _feedFilter = items;
-                              onConfirm: (items) {
+                                      });
-                                setState(() {
+                                    },
-                                  _feedFilter = items;
+                                  ),
-                                });
+                                ),
-                              },
+                              );
-                            ),
+                            },
                           ),
-                        );
+                          PopupMenuItem(
-                      },
+                            value: "feedback",
-                    ),
+                            child: const Text("Feedback"),
-                  ]),
+                            onTap: () async {
-        ],
+                              await openUrl(context,
+                                  "https://git.amogus.cloud/Lea/feet/issues");
+                            },
+                          ),
+                        ]),
+              ]
+            : [],
       ),
       bottomNavigationBar: BottomNavigationBar(
         currentIndex: _index,

lib/notifications/tasks.dart

@@ -1,6 +1,8 @@
 import 'dart:math';
 
 import 'package:feet/api/api.dart';
+import 'package:feet/main.dart';
+import 'package:feet/pages/article.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_local_notifications/flutter_local_notifications.dart';
@@ -19,7 +21,7 @@ void callbackDispatcher() {
       try {
         var initialized = await FlutterLocalNotificationsPlugin().initialize(
           const InitializationSettings(
-            android: AndroidInitializationSettings('@mipmap/ic_launcher'),
+            android: AndroidInitializationSettings('notification_icon'),
           ),
         );
 
@@ -79,10 +81,11 @@ void callbackDispatcher() {
           }
 
           await FlutterLocalNotificationsPlugin().show(
-            Random().nextInt(10000000), // Can't use the post ID here because
+            Random().nextInt(
-            // FreshRSS's IDs are too large
+                10000000), // Can't use the post ID here because FreshRSS's IDs are too large
             feed != null ? 'New post - ${feed.title}' : 'New post',
             item.title,
+            payload: 'item/${item.id}',
             NotificationDetails(
               android: AndroidNotificationDetails(
                 'new_posts',
@@ -91,6 +94,8 @@ void callbackDispatcher() {
                 channelShowBadge: true,
                 importance: Importance.low,
                 largeIcon: iconData,
+                when: item.createdOnTime.millisecondsSinceEpoch,
+                showWhen: true,
               ),
             ),
           );
@@ -116,6 +121,35 @@ void setupBackgroundTasks() async {
 
   await Permission.notification.request();
 
+  await FlutterLocalNotificationsPlugin().initialize(
+    const InitializationSettings(
+      android: AndroidInitializationSettings('notification_icon'),
+    ),
+    onSelectNotification: handleNotificationClick,
+  );
+
+  var launchDetails =
+      await FlutterLocalNotificationsPlugin().getNotificationAppLaunchDetails();
+
+  if (launchDetails?.payload != null && launchDetails!.payload!.isNotEmpty) {
+    handleNotificationClick(launchDetails.payload);
+  }
+
+  // Test notification
+  //if (kDebugMode) {
+  //  await FlutterLocalNotificationsPlugin().show(
+  //      Random().nextInt(1000000),
+  //      "Test Notification",
+  //      "Test Notification Body",
+  //      const NotificationDetails(
+  //        android: AndroidNotificationDetails(
+  //          'new_posts',
+  //          'New posts',
+  //        ),
+  //      ),
+  //      payload: "item/1675609277381551");
+  //}
+
   // Runs every 15 minutes
   await Workmanager().registerPeriodicTask(
     'fetch_notifications',
@@ -124,3 +158,47 @@ void setupBackgroundTasks() async {
     initialDelay: const Duration(seconds: 60),
   );
 }
+
+Future<void> handleNotificationClick(String? payload) async {
+  print("Notification click: $payload");
+  if (globalContext == null) {
+    print("Global context not available.");
+    return;
+  }
+  if (payload == null) {
+    print("Didn't receive a payload");
+    return;
+  }
+
+  try {
+    if (payload.startsWith('item/')) {
+      if (!api.loggedIn()) {
+        print("API client is not logged in");
+        return;
+      }
+
+      var id = toInt(payload.split('/')[1]);
+      var item = api.cache.items.get(id);
+      if (item == null) {
+        var res = await api.request().withItems().withIds([id]).execute();
+        item = api.cache.items.get(id);
+        if (item == null) throw 'Didn\'t receive item $id from API: $res';
+      }
+
+      Navigator.of(globalContext!).push(
+        MaterialPageRoute(
+          builder: (context) => ArticlePage(article: item!),
+        ),
+      );
+
+      if (!item.isRead) {
+        await api
+          .request()
+          .markItem(item, ItemMarkType.read)
+          .execute();
+      }
+    }
+  } catch (e) {
+    print("Error while handling notification click: $e");
+  }
+}

lib/pages/article.dart

@@ -1,10 +1,10 @@
 import 'package:feet/api/api.dart';
+import 'package:feet/pages/image_view.dart';
+import 'package:feet/util.dart';
 import 'package:feet/widgets/homepage_post.dart';
 import 'package:flutter/material.dart';
-import 'package:flutter/services.dart';
 import 'package:flutter_html/flutter_html.dart';
 import 'package:share_plus/share_plus.dart';
-import 'package:url_launcher/url_launcher.dart';
 
 class ArticlePage extends StatefulWidget {
   final Item article;
@@ -22,11 +22,9 @@ class _ArticlePageState extends State<ArticlePage> {
         title: Text(widget.article.title),
         content: Text(
           // The dart formatter insists of writing this like this
-          'By ${widget.article.author.isEmpty ? '(Unknown author)' : widget.article.author}\nPublished on ${formatDate(widget.article.createdOnTime)}${debugInfo
+          'By ${widget.article.author.isEmpty ? '(Unknown author)' : widget.article.author}\nPublished on ${formatDate(widget.article.createdOnTime)}${debugInfo ? '\nID: ${widget.article.id}\n'
-            ? '\nID: ${widget.article.id}\n'
               'Is read: ${widget.article.isRead ? 'Yes' : 'No'}\n'
-              'Is saved: ${widget.article.isSaved ? 'Yes' : 'No'}'
+              'Is saved: ${widget.article.isSaved ? 'Yes' : 'No'}' : ''}',
-            : ''}',
         ),
         actions: debugInfo
             ? []
@@ -62,41 +60,7 @@ class _ArticlePageState extends State<ArticlePage> {
             itemBuilder: (context) => [
               PopupMenuItem(
                 onTap: () async {
-                  try {
+                  await openUrl(context, widget.article.url);
-                    if (await canLaunchUrl(Uri.parse(widget.article.url))) {
-                      await launchUrl(
-                        Uri.parse(widget.article.url),
-                        mode: LaunchMode.externalApplication,
-                      );
-                    } else {
-                      throw 'No application available to open URL';
-                    }
-                  } catch (e) {
-                    showDialog(
-                      context: context,
-                      builder: (context) => AlertDialog(
-                        title: const Text('Cannot open this URL'),
-                        content: Text(e.toString()),
-                        actions: [
-                          TextButton(
-                            onPressed: () {
-                              Navigator.of(context).pop();
-                              Clipboard.setData(
-                                ClipboardData(
-                                  text: widget.article.url,
-                                ),
-                              );
-                            },
-                            child: const Text('Copy URL'),
-                          ),
-                          TextButton(
-                            onPressed: () => Navigator.of(context).pop(),
-                            child: const Text('Got it!'),
-                          ),
-                        ],
-                      ),
-                    );
-                  }
                 },
                 value: 'open_in_browser',
                 child: const Text('Open in browser'),
@@ -107,9 +71,27 @@ class _ArticlePageState extends State<ArticlePage> {
       ),
       body: ListView(
         children: [
-          SelectableHtml(
+          Container(
-            data: widget.article.html,
+            margin: const EdgeInsets.all(12.0),
-          ),
+            child: SelectionArea(
+              child: Html(
+                data: widget.article.html,
+                onImageTap: (url, ctx, attributes, element) =>
+                    Navigator.of(context).push(
+                  PageRouteBuilder(
+                    opaque: false,
+                    pageBuilder: (context, _, __) => ImageView(url: url!),
+                    transitionsBuilder: (context, animation, _, child) {
+                      return FadeTransition(
+                        opacity: animation,
+                        child: child,
+                      );
+                    },
+                  ),
+                ),
+              ),
+            ),
+          )
         ],
       ),
     );

lib/pages/image_view.dart

@@ -0,0 +1,17 @@
+import 'package:flutter/material.dart';
+import 'package:photo_view/photo_view.dart';
+
+class ImageView extends StatelessWidget {
+  final String url;
+  const ImageView({super.key, required this.url});
+
+  @override
+  Widget build(BuildContext context) {
+    return PhotoView(
+      backgroundDecoration: BoxDecoration(color: Theme.of(context).colorScheme.background.withAlpha(200)),
+      maxScale: 5.0,
+      minScale: PhotoViewComputedScale.contained,
+      imageProvider: NetworkImage(url),
+    );
+  }
+}

lib/pages/login.dart

@@ -4,7 +4,7 @@ import 'package:shared_preferences/shared_preferences.dart';
 
 class LoginPage extends StatefulWidget {
   final FeverAPI api;
-  const LoginPage({ super.key, required this.api });
+  const LoginPage({super.key, required this.api});
 
   @override
   State<LoginPage> createState() => _LoginPageState();
@@ -66,15 +66,16 @@ class _LoginPageState extends State<LoginPage> {
               children: [
                 const Text("Fever compatible API URL"),
                 TextField(
-                  controller: _urlController,
+                    controller: _urlController,
-                  focusNode: _urlFocus,
+                    focusNode: _urlFocus,
-                  decoration: InputDecoration(
+                    decoration: InputDecoration(
-                    border: const OutlineInputBorder(),
+                      border: const OutlineInputBorder(),
-                    contentPadding: const EdgeInsets.all(8.0),
+                      contentPadding: const EdgeInsets.all(8.0),
-                    hintText: 'https://among-us.morbius.sus/api/fever.php',
+                      hintText: 'https://among-us.morbius.sus/api/fever.php',
-                    errorText: _validAPI == false ? 'Invalid or unsupported API' : null,
+                      errorText: _validAPI == false
-                  )
+                          ? 'Invalid or unsupported API'
-                ),
+                          : null,
+                    )),
               ],
             ),
           ),
@@ -87,7 +88,8 @@ class _LoginPageState extends State<LoginPage> {
                 Row(
                   mainAxisAlignment: MainAxisAlignment.spaceEvenly,
                   children: [
-                    Flexible(child: TextField(
+                    Flexible(
+                        child: TextField(
                       controller: _usernameController,
                       decoration: const InputDecoration(
                         border: OutlineInputBorder(),
@@ -96,7 +98,8 @@ class _LoginPageState extends State<LoginPage> {
                       ),
                     )),
                     const SizedBox(width: 8),
-                    Flexible(child: TextField(
+                    Flexible(
+                        child: TextField(
                       controller: _passwordController,
                       decoration: const InputDecoration(
                         border: OutlineInputBorder(),
@@ -110,43 +113,98 @@ class _LoginPageState extends State<LoginPage> {
               ],
             ),
           ),
-          ElevatedButton(
+          Container(
-            onPressed: () async {
+            margin: const EdgeInsets.symmetric(horizontal: 16.0, vertical: 4.0),
-              if (_urlController.text.isEmpty) return;
+            child: Row(
-              _validAPI ??= await checkUrl();
+              mainAxisAlignment: MainAxisAlignment.spaceBetween,
-              if (_validAPI != true || _usernameController.text.isEmpty || _passwordController.text.isEmpty) return;
+              children: [
+                ElevatedButton(
+                  onPressed: () {
+                    showDialog(
+                      context: context,
+                      builder: (context) => AlertDialog(
+                        title: const Text("Connect to demo instance"),
+                        content: const Text(
+                            "If you want to try out this application before setting "
+                            "up your own RSS aggregator, you can connect to our demo instance.\n\n"
+                            "Please note that the demo server is not intended "
+                            "for normal usage. If you intend to use this app, "
+                            "please set up your own server."),
+                        actions: [
+                          TextButton(
+                            onPressed: () => Navigator.of(context).pop(),
+                            child: const Text("Cancel"),
+                          ),
+                          TextButton(
+                            onPressed: () async {
+                              var apiUrl = "https://rss.amogus.cloud/api/fever.php";
+                              var apiKey = FeverAPI.generateApiKey("demo", "PF6bdYLH");
 
-              var apiKey = FeverAPI.generateApiKey(_usernameController.text, _passwordController.text);
+                              final prefs = await SharedPreferences.getInstance();
-              var isAuthenticated = await FeverAPI.isAuthenticated(_urlController.text, apiKey);
+                              await prefs.setString('apiUrl', apiUrl);
+                              await prefs.setString('apiKey', apiKey);
+                              await prefs.setBool('isDemo', true);
 
-              if (!isAuthenticated) {
+                              widget.api.apiUrl = apiUrl;
-                // ignore: use_build_context_synchronously
+                              widget.api.apiKey = apiKey;
-                showDialog(
+                              // ignore: use_build_context_synchronously
-                  context: context,
+                              Navigator.of(context).popUntil((route) => route.isFirst);
-                  builder: (BuildContext context) {
+                            },
-                    return AlertDialog(
+                            child: const Text("Connect!"),
-                      title: const Text('Authentication failed'),
+                          )
-                      content: const Text('The API URL seems to be valid, but the provided credentials appear to be incorrect.'),
+                        ],
-                      actions: [
+                      ),
-                        TextButton(onPressed: () => Navigator.of(context).pop(), child: const Text('Got it!')),
-                      ],
                     );
-                  }
+                  },
-                );
+                  child: const Text("Demo"),
+                ),
+                ElevatedButton(
+                  onPressed: () async {
+                    if (_urlController.text.isEmpty) return;
+                    _validAPI ??= await checkUrl();
+                    if (_validAPI != true ||
+                        _usernameController.text.isEmpty ||
+                        _passwordController.text.isEmpty) return;
 
-                return;
+                    var apiKey = FeverAPI.generateApiKey(
-              }
+                        _usernameController.text, _passwordController.text);
+                    var isAuthenticated = await FeverAPI.isAuthenticated(
+                        _urlController.text, apiKey);
 
-              final prefs = await SharedPreferences.getInstance();
+                    if (!isAuthenticated) {
-              await prefs.setString('apiUrl', _urlController.text);
+                      // ignore: use_build_context_synchronously
-              await prefs.setString('apiKey', apiKey);
+                      showDialog(
+                          context: context,
+                          builder: (BuildContext context) {
+                            return AlertDialog(
+                              title: const Text('Authentication failed'),
+                              content: const Text(
+                                  'The API URL seems to be valid, but the provided credentials appear to be incorrect.'),
+                              actions: [
+                                TextButton(
+                                    onPressed: () =>
+                                        Navigator.of(context).pop(),
+                                    child: const Text('Got it!')),
+                              ],
+                            );
+                          });
 
-              widget.api.apiUrl = _urlController.text;
+                      return;
-              widget.api.apiKey = apiKey;
+                    }
-              // ignore: use_build_context_synchronously
+
-              Navigator.of(context).pop();
+                    final prefs = await SharedPreferences.getInstance();
-            },
+                    await prefs.setString('apiUrl', _urlController.text);
-            child: const Text('Continue'),
+                    await prefs.setString('apiKey', apiKey);
+
+                    widget.api.apiUrl = _urlController.text;
+                    widget.api.apiKey = apiKey;
+                    // ignore: use_build_context_synchronously
+                    Navigator.of(context).pop();
+                  },
+                  child: const Text('Continue'),
+                ),
+              ],
+            ),
           ),
         ],
       ),

lib/util.dart

@@ -0,0 +1,41 @@
+import 'package:flutter/material.dart';
+import 'package:flutter/services.dart';
+import 'package:url_launcher/url_launcher.dart';
+
+Future<void> openUrl(BuildContext context, String url) async {
+    try {
+        if (await canLaunchUrl(Uri.parse(url))) {
+          await launchUrl(
+            Uri.parse(url),
+            mode: LaunchMode.externalApplication,
+          );
+        } else {
+          throw 'No application available to open URL';
+        }
+      } catch (e) {
+        showDialog(
+          context: context,
+          builder: (context) => AlertDialog(
+            title: const Text('Cannot open this URL'),
+            content: Text(e.toString()),
+            actions: [
+              TextButton(
+                onPressed: () {
+                  Navigator.of(context).pop();
+                  Clipboard.setData(
+                    ClipboardData(
+                      text: url,
+                    ),
+                  );
+                },
+                child: const Text('Copy URL'),
+              ),
+              TextButton(
+                onPressed: () => Navigator.of(context).pop(),
+                child: const Text('Got it!'),
+              ),
+            ],
+          ),
+        );
+      }
+}

lib/widgets/favicon.dart

@@ -0,0 +1,26 @@
+import 'dart:convert';
+
+import 'package:flutter/material.dart';
+
+class PostFavicon extends StatelessWidget {
+  final String faviconData;
+  const PostFavicon(this.faviconData, {super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    try {
+      return Image.memory(
+        base64Decode(faviconData.split(',')[1]),
+        width: 20,
+        height: 20,
+        errorBuilder: (context, error, stackTrace) {
+          print("Failed to render favicon: $error");
+          return Container();
+        },
+      );
+    } catch (e) {
+      print("Caught exception while trying to render favicon: $e");
+      return Container();
+    }
+  }
+}

lib/widgets/filter_menu.dart

@@ -69,6 +69,16 @@ class _FilterMenuState extends State<FilterMenu> {
         Row(
           mainAxisAlignment: MainAxisAlignment.spaceEvenly,
           children: [
+            TextButton(
+              onPressed: () {
+                setState(() {
+                  _checked.forEach((key, value) {
+                    _checked[key] = false;
+                  });
+                });
+              },
+              child: const Text("Reset")
+            ),
             TextButton(
               onPressed: () {
                 List<int> items = _checked.keys
@@ -80,15 +90,6 @@ class _FilterMenuState extends State<FilterMenu> {
               },
               child: const Text("Done"),
             ),
-            TextButton(
-                onPressed: () {
-                  setState(() {
-                    _checked.forEach((key, value) {
-                      _checked[key] = false;
-                    });
-                  });
-                },
-                child: const Text("Reset")),
           ],
         )
       ],

lib/widgets/homepage_post.dart

@@ -1,11 +1,9 @@
-import 'dart:convert';
-
 import 'package:feet/pages/article.dart';
+import 'package:feet/widgets/favicon.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import '../api/api.dart';
 
-// TODO use some localization library
 String formatDate(DateTime date) {
   return '${date.day}.${date.month}.${date.year}, ${date.hour}:${date.minute < 10 ? '0${date.minute}' : date.minute}';
 }
@@ -78,11 +76,7 @@ class _HomepagePostState extends State<HomepagePost> {
                     favicon?.data != null
                         ? Container(
                           margin: const EdgeInsets.fromLTRB(0, 0, 6, 4),
-                          child: Image.memory(
+                          child: PostFavicon(favicon!.data),
-                            base64Decode(favicon!.data.split(',')[1]),
-                            width: 20,
-                            height: 20,
-                          ),
                         )
                         : Container(),
                     Expanded(

lib/widgets/login_prompt.dart

@@ -9,14 +9,17 @@ class LoginPrompt extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return Column(
+      mainAxisAlignment: MainAxisAlignment.center,
       children: [
         const Text('Please log in'),
+        const SizedBox(height: 8),
         ElevatedButton(
           onPressed: () {
             Navigator.push(context, MaterialPageRoute(builder: (context) => LoginPage(api: api)));
           },
           child: const Text('Log in'),
         ),
+        const SizedBox(height: 80),
       ],
     );
   }

pubspec.lock

@@ -440,6 +440,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "5.1.0"
+  photo_view:
+    dependency: "direct main"
+    description:
+      name: photo_view
+      sha256: "8036802a00bae2a78fc197af8a158e3e2f7b500561ed23b4c458107685e645bb"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.14.0"
   platform:
     dependency: transitive
     description:

pubspec.yaml

@@ -1,5 +1,5 @@
 name: feet
-description: A new Flutter project.
+description: Modern Flutter based Android client for Fever compatible news sources using Material 3
 # The following line prevents the package from being accidentally published to
 # pub.dev using `flutter pub publish`. This is preferred for private packages.
 publish_to: 'none' # Remove this line if you wish to publish to pub.dev
@@ -45,6 +45,7 @@ dependencies:
   workmanager: ^0.5.1
   flutter_local_notifications: ^9.1.4
   permission_handler: ^10.2.0
+  photo_view: ^0.14.0
 
 dev_dependencies:
   flutter_test:

test/api_test.dart

@@ -0,0 +1,56 @@
+import 'package:feet/api/api.dart';
+import 'package:flutter_test/flutter_test.dart';
+
+void main() {
+  group("API", () {
+    test("API key hashing", () {
+      final hash = FeverAPI.generateApiKey("bob", "abcdefgh");
+      expect(hash, "0fd86d2d609be5de9dce2ac77ad939a4");
+    });
+
+    test("API request builder", () {
+      final api = FeverAPI(apiUrl: "https://deez.org");
+
+      final item = Item(api,
+          id: 44,
+          feedId: 4,
+          title: "Morbius",
+          author: "Imposter from Among",
+          html: "<p>deez</p>",
+          url: "https://amogus.org",
+          isSaved: true,
+          isRead: false,
+          createdOnTime: DateTime.now());
+
+      final request = api
+          .request()
+          .withItems()
+          .withGroups()
+          .withFeeds()
+          .withFavicons()
+          .withIds([1, 2])
+          .sinceId(69)
+          .maxId(420)
+          .markItem(item, ItemMarkType.read);
+
+      expect(request.args, [
+        "items",
+        "groups",
+        "feeds",
+        "favicons",
+        "with_ids=1,2",
+        "since_id=69",
+        "max_id=420",
+        "mark=item",
+        "as=read",
+        "id=44",
+      ]);
+
+      expect(
+          request.generateUrl(),
+          Uri.parse("https://deez.org?api&items&groups&feeds&favicons&with_ids=1,2&since_id=69&max_id=420&mark=item&as=read&id=44"));
+    });
+
+    // TODO: Test item/feed/group/etc constructors
+  });
+}