Blog

  • laravel-appleseed

    Appleseed for Laravel

    Appleseed for Laravel masthead image.

    Join the chat at https://gitter.im/GeneaLabs/laravel-appleseed Build Status Coverage Status

    Reasoning

    Eliminate error and server log entries that get thrown by missing favicons, especially the apple-touch-icon.png errors.

    Considerations

    If you are seeing errors in your server logs, its for a reason: favicons are custom representations of your site, and its probably good to implemented them. This just provides a better user experience for the various devices and browsers that want them.

    However, there are times when we just don’t want to deal with this, and are spinning up in-house or small experimental projects that won’t be used publicly like that. That’s what this package is for. Simply add it via composer, and add middleware entry as describe below, and it will return 404s for the missing favicons without cluttering your logs.

    Dependencies

    • Your project should be running Laravel 5+.

    Installation

    1. Install Laravel Appleseed via composer:
    composer require genealabs/laravel-appleseed
    1. Add the middleware entry in app/Http/Kernel.php directly after the maintenance mode middleware:
    /*
        protected $middleware = [
            \Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
    */
            \GeneaLabs\LaravelAppleseed\Http\Middleware\FaviconInterceptor::class,
    /*
            [...]
        ];
    */

    Usage

    That was it! It will inspect each route for favicon requests and handle it appropriately.

    Credits

    Jesse Leite (@jesseleite85) provided lots of ideas and input on making this happen. Thanks!

    Visit original content creator repository https://github.com/mikebronner/laravel-appleseed
  • CDR_2016-TechTheTowel-LowLevel

                        GNU GENERAL PUBLIC LICENSE
                           Version 3, 29 June 2007
    
     Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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:
    
        {project}  Copyright (C) {year}  {fullname}
        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
    <http://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
    <http://www.gnu.org/philosophy/why-not-lgpl.html>.
    

    Visit original content creator repository
    https://github.com/Club-INTech/TechTheTowel-LowLevel

  • Waymaker

    background2 jpg

    Sobre o Projeto

    O Waymaker é um projeto pessoal sobre aplicativos direcionado aos usuários de transporte público(usuários frequentes ou esporádicos). Tal iniciativa teve na minha experiência como usuário desse mesmo sistema o ponto de partida para o projeto. A ideação do projeto começou a partir do principal questionamento, “Como uma pessoa que desconhece um determinado local é capaz de se locomover por ele?”. Assim foi feita uma breve pesquisa com alguns usuários utilizando-se de técnicas de UX como, entrevistas, questionário, Análise de Benchmarking e testes de usabilidade para, assim, projetar uma arquitetura visual mais eficiente na transmissão de informação aos usuários e que atende de fato as suas demandas.

    Um pouco sobre a identidade visual do aplicativo => Link

    Protótipo => Link

    If you would like to check the UX process go to this link –> Breve 😀

    This is a personal project about mobile aplications for public transport. I had my own experience, as a user, to kick start the project. It all started from the main questioning,”How can a person who is unaware of a certain location capable of getting around it?”. So a brief research with users took place based on UX Designig process to design a more efficient visual architecture to communicate to users all information that actually meets their demands.

    Processo

    1. Passo – Pesquisa exploratória
    2. Através de entrevistas, questionário e um mapa de empatia foi possível levantar algumas informações sobre como os usuários se sentem frente às dificuldades que enfrentam na utilização do sistema de transporte público. Sentimentos de insegurança, frustração e ansiedade foram expostos pela maioria dos entrevistados. Dentre as principais dificuldades relatadas estavam a dificuldade de acesso a informações sobre o sistema e orientações sobre trajetos. Na maioria das vezes os usuários recorrem a outros usuários para ter tais informações.
    3. Passo – Análise de Benchmark
    4. Foram selecionados para a análise os aplicativos ofertados pelas empresas de transporte público da cidade do Rio de Janeiro, Manaus e Vitória. De modo geral os aplicativos não apresentavam um fluxo de navegação muito claro bem como uma hierarquia visual bem prejudicada. Mesmo assim esses aplicativos apresentavam alguns recursos de relevância para os usuários. O aplicativo referencial para este projeto passou a ser o Moovit, pois apresentava todos os recursos apresentados pelos aplicativos anteriores e mais alguns, como, monitoramento de trajeto. O único recurso ausente é o tempo real de previsão dos veículos.
    5. Passo – Personas e Definição de requisitos
    6. A partir da elaboração de perfis de Personas(5 personas) as quais comportassem as principais características dos usuários de transporte público, além disso se deu a construção de alguns cenários de caso de uso, assim, a partir da análise desses passos foi possível levantar a relação de objetivos que o usuário tem ao utilizar o sistema.

    Interface de usuário

    A partir da elaboração da relação de objetivos de usuários foi feito o fluxo de telas em baixa fidelidade, a construção de um protótipo inicial o qual foi submetido a alguns testes com usuário e a partir das informações coletadas foram implementadas novas alterações e novos testes subsequentes. Esse é o resultado obtido até o momento.

    Principais Contribuições

    Uma das principais contribuições foi o redesign da informação das telas de rotas disponíveis e direções, onde por meio de uma estrutura formal de um diagrama de processo. Dessa forma a numeração reforça a ideia de escolhas disponíveis(quantidade) e a sucessão de estágios de um processo(direção). A aplicação de cores como uma camada de informação reforçando os diferentes estágios da viagem. Todas essas estratégias têm como objetivo tornar mais clara e intuitiva a navegação do usuário pelas informações. A possibilidade de compartilhar localização e construir rotas personalizadas ajuda a reduzir a chance dos usuários se perderem ao desenvolver novos trajetos, pois se trata de uma fonte de informação confiável.

    Implementação

    Visit original content creator repository https://github.com/Felipe-S-Borges/Waymaker
  • ngx-testing

    NgxTesting

    Build Status Coverage Npm Npm Downloads Licence semantic-release

    Testing utilities for Angular projects

    npm install -D @orchestrator/ngx-testing@next

    Why?

    Because you want to test your code and not writing testing code to test your code.

    How?

    This utility library will generate a wrapping (host) component for your component under test and bind all the @Inputs and @Outputs for you so you can interact with component as the consumer will.

    That also means that you do not need to worry about life-cycle hooks hassle because auto generated code will move this bit to Angular itself.

    Getting started

    Configuring mocking (Optional)

    Library will initialize every @Output property on host component to a mock so you have a nice time checking if the output was triggered.

    By default it is simply a NOOP function (that does nothing).

    But which testing tool do you use is up to you so you have to tell us what to use by writing next code in your main test configuration file:

    import { setOutputMock } from '@orchestrator/ngx-testing';
    
    // Use this for Jasmine Spies
    setOutputMock(() => jasmine.createSpy());
    
    // Or this for Jest Mocks
    setOutputMock(() => jest.fn());
    
    // Optionally you can provide typings for mocks
    declare module '@orchestrator/ngx-testing' {
      // Use this for Jasmine Spies
      interface OutputMock<T> extends jasmine.Spy {}
    
      // Or this for Jest Mocks
      interface OutputMock<T> extends jest.Mock {}
      // <T> here represents actual type from `EventEmitter<T>`
      // You can use it if you need it
    }

    Testing component

    Let’s see how to test a component with this library:

    import { TestBed } from '@angular/core/testing';
    import { getTestingForComponent } from '@orchestrator/ngx-testing';
    
    // This is component under test
    @Component({ selector: 'my-component', template: 'Text is: {{text}}' })
    class MyComponent implements OnInit, OnChanges {
      @Input() text: string;
    }
    
    describe('MyComponent', () => {
      // This will generate host component and module with everything required
      const { testModule, createComponent } = getTestingForComponent(MyComponent);
    
      // Configure testing module by importing generated module before
      beforeEach(() => TestBed.configureTestingModule({ imports: [testModule] }));
    
      it('should render input text', async () => {
        // Now simply create host component
        // It is async because it performs compilation of templates
        // And returns a special Host service that contains a bunch of useful stuff
        const host = await createComponent();
    
        // To interact with your component Inputs/Outputs use `hostComponent` property
        // It's an instance of generated host component that binds all Inputs and Outputs
        host.hostComponent.text = 'something';
        // This is an alias to fixture.detectChanges()
        // Fixture can be used as well and is available as `fixture` property
        host.detectChanges();
    
        // htmlElement is simply an HTMLElement of rendered component under test
        expect(host.htmlElement.textContent).toBe(`Text is: something`);
      });
    });

    For more examples visit example-component.spec.ts.

    Providing custom config for NgModule

    Sometimes you will need to provide extra config for your component/directive under test so it can work in isolated unit test. You can do this like so:

    import { getTestingForComponent, getTestingForDirective } from '@orchestrator/ngx-testing';
    
    // For component
    getTestingForComponent(YourComponent, { ngModule: { imports: [...], providers: [...] } });
    
    // For directive
    getTestingForDirective(YourDirective, { ngModule: { imports: [...], providers: [...] } });

    NOTE: ngModule prop in second argument is default config for @NgModule.

    Initial Inputs

    You can set initial inputs to component when creating it:

    const host = createComponent({ prop1: 'value', prop2: 'value2' });

    Also while setting initial inputs you may trigger Change Detection so that the view will immediately render with the inputs:

    const host = createComponent({ ...inputs }, true);

    Setting Inputs

    During test you may set inputs using utility method setInputs():

    host.setInputs({ prop1: 'value1', prop2: 'value2' });

    Also while setting inputs you may trigger Change Detection so that the view will immediately render with the inputs:

    host.setInputs({ ...inputs }, true);

    Build

    Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

    Running unit tests

    Run ng test to execute the unit tests via Karma.

    Running end-to-end tests

    Run ng e2e to execute the end-to-end tests via Protractor.

    Visit original content creator repository https://github.com/orchestratora/ngx-testing
  • akka-management

    Akka (Cluster) Management

    The Akka family of projects is managed by teams at Lightbend with help from the community.

    This repository contains interfaces to inspect, interact and manage various Parts of Akka, primarily Akka Cluster.
    Future additions may extend these concepts to other parts of Akka.

    Documentation

    See reference and API

    Contributions & Maintainers

    This project does not have contributors, it only has maintainers—frequent and infrequent—and everyone helps out.
    We love new maintainers as well as old maintainers. 🙂
    The Akka core team keeps an eye on the project to assure its overall coherence but does not fully support these modules.

    Contributions are very welcome, see CONTRIBUTING.md or skim existing tickets to see where you could help out.

    Project Status

    With the exception of the community maintained modules listed below version 1.0.0 or later of this library
    is ready to be used in production, APIs are stable, and the Lightbend subscription covers support for these modules.

    The following modules are maintained by the community and does not have to obey the rule of staying binary compatible
    between releases. Breaking API changes may be introduced without notice as we refine and simplify based on feedback.
    A module may be dropped in any release without prior deprecation. The Lightbend subscription does not cover support
    for the following modules.

    • akka-discovery-aws-api
    • akka-discovery-aws-api-async
    • akka-discovery-marathon-api (End of Life)

    License

    Akka is licensed under the Business Source License 1.1, please see the Akka License FAQ.

    Tests and documentation are under a separate license, see the LICENSE file in each documentation and test root directory for details.

    Visit original content creator repository
    https://github.com/akka/akka-management

  • openleetcode

    OpenLeetCode – An open source version of LeetCode

    Welcome to the OpenLeetCode Project!

    The motivation behind this project is to be able to practice LeetCode problems on a plane without requiring an internet connection (until Starlink ramps up). This project is not intended to replace or replicate leetcode.com.

    Table of Content

    Screenshot

    Screenshot

    Build

    Windows

    Building without UI

    git clone https://github.com/mbucko/openleetcode
    cd openleetcode
    .\install --prefix=./install

    Building with UI

    git clone https://github.com/mbucko/openleetcode
    cd openleetcode
    .\install --prefix=./install --enable_ui

    Unix

    Building without UI

    git clone https://github.com/mbucko/openleetcode
    cd openleetcode
    ./install.sh --prefix=./install

    Building with UI

    git clone https://github.com/mbucko/openleetcode
    cd openleetcode
    ./install.sh --prefix=./install --enable_ui

    Run

    Windows

    CLI

    dir install/OpenLeetCode
    ./openleetcode --language cpp --problem TwoSum

    UI

    dir install/OpenLeetCode
    ./openleetcodeui

    Unix

    CLI

    cd install/OpenLeetCode
    ./openleetcode.sh --language cpp --problem TwoSum

    UI

    cd install/OpenLeetCode
    ./openleetcodeui.sh

    NOTE: UI for unix is yet to be tested.

    How To Use

    After the build succeeds, the following directory structure will be generated:

    • problems
      • NumberOfIslands
        • cpp
          • solution.cpp
        • testcases
          • TestCase1.test
          • TestCase2.test
        • description.md
      • TwoSum
        • ..
    • launguage
      • cpp

    Just like for LeetCode, you have one file where you solve the problem. For example, the problem called TwoSum has problems/TwoSum/cpp/solution.cpp. To add new test cases, you can create a file in the problems/TwoSum/testcases/ directory with the file extension .test, and the solution will automatically be tested against it.

    Each problem is described in the description.md file location in the problem’s directory. For example problems/TwoSum/description.md.

    The format of the .test files are as follows:

    <arg1>
    <arg2>
    <expected results>
    

    The supported types are: integral type, a string, TreeNode structure, boolean or an array. For example:

    ["1", "2", "4"]
    8.0
    [0, 0]
    

    A ThreeNode structure is represented in an array-based structure. For example an array representation [1, 2, null, null, 3] results to the following structure:

      1
     / \
    2   3
    

    List of LeetCode Problems

    • TwoSum
    • LongestSubstringWithoutRepeatingCharacters
    • NumberOfIslands
    • CheckCompletenessOfABinaryTree

    The problem names are automatically extracted from the problems folder.

    Usage

    $ python openleetcode.py --help
    usage: openleetcode.py [-h] [--language {cpp}] [--list-problems] [--list-testcases] [--problem problem_name] [--problem_builds_dir dir] [--testcase testcase_name] [--verbose]
    
    OpenLeetCode problem builder. This script builds and tests LeetCode-like problems locally. Currently, it only supports the C++ language, but it can be extended to support other languages.
    
    options:
      -h, --help            show this help message and exit
      --language {cpp}, -l {cpp}
                            The programming language.
      --list-problems       List problems.
      --list-testcases      List testcases for a problem specified with '--problem' option.
      --problem problem_name, -p problem_name
                            Name of the problem to build and test. Default: TwoSum. Use --list-problems to list all problems.
      --problem_builds_dir dir, -d dir
                            Specifies the directory with the problems. Typically, this is './problem_builds'. If not provided, the script defaults to './problem_builds' in the same directory as the executable.
      --run-expected-tests, -r
                            Run the expected solution. Default: False.
      --testcase testcase_name, -t testcase_name
                            Name of the testcase to run. '--testcase All' will run all testcases. Default: All.
      --verbose, -v         Print verbose output
    

    Note

    Curently only C++ is supported but the framework is setup such that other languages can be added.

    Requirements

    This project requires the following to run:

    • Python
    • CMake 3.12
    • Git

    Additional Requirements for the UI

    • npm

    Contributing

    Feel free to contribute with code, test cases, or even code reviews.

    For a more in-depth guide on how to contribute and information about the inner workings of OpenLeetCode, please refer to the Docs. You can also join our Discord chat if you have any questions about the usage or development.

    Visit original content creator repository https://github.com/mbucko/openleetcode
  • Streaming-WebSockets-ID

    WebSocket Token Streaming Application

    This project demonstrates a streaming application using FastAPI, Spring Boot, and React with WebSockets. The user sends a message from the frontend, which Spring Boot receives. Spring Boot checks the message in messages.txt, retrieves the corresponding ID, and sends the ID to FastAPI. FastAPI checks responses.txt for the received ID and sends the corresponding response back to Spring Boot. Spring Boot then streams the response letter by letter to React, which displays it to the user.

    Project Structure

    websocket-token-streaming/
    ├── backend/
    │   ├── springboot/
    │   │   ├── src/
    │   │   │   ├── main/
    │   │   │   │   ├── java/com/example/websocket/
    │   │   │   │   │   ├── WebSocketHandler.java
    │   │   │   │   │   ├── Application.java
    │   │   │   │   │   ├── WebSocketConfig.java
    │   │   │   │   │   ├── config/
    │   │   │   │   │   │   └── WebConfig.java
    │   │   │   │   └── resources/
    │   │   │   │       ├── messages.txt
    │   │   ├── pom.xml
    │   └── fastapi/
    │       ├── main.py
    │       ├── responses.txt
    │       ├── requirements.txt
    ├── frontend/
    │   ├── websocket-client/
    │   │   ├── src/
    │   │   │   ├── App.js
    │   │   │   ├── App.css
    │   │   │   ├── index.js
    │   │   │   ├── index.css
    │   │   ├── public/
    │   │   │   └── index.html
    │   ├── package.json
    │   ├── package-lock.json
    ├── README.md
    

    Features

    1. WebSocket Communication: Real-time communication between frontend and backend using WebSockets.

    2. Message ID Lookup: Spring Boot looks up message IDs from messages.txt.

    3. Response Retrieval: FastAPI retrieves responses based on IDs from responses.txt.

    4. Letter by Letter Streaming: Responses are streamed letter by letter to the frontend.

    5.React Frontend: Interactive user interface to send messages and display responses.

    Prerequisites

    Java Development Kit (JDK)

    Python 3.7+

    Node.js and npm

    Usage

    1. Open the React app in your browser at http://localhost:3000.

    2. Type a message in the input field and press Enter or click the Send button.

    3. The response will be displayed letter by letter in real-time.

    File Overview

    Backend

    Spring Boot

    WebSocketHandler.java: Handles WebSocket connections and message processing.

    messages.txt: Contains predefined messages with corresponding IDs.

    FastAPI

    main.py: FastAPI server handling WebSocket connections and message processing.

    responses.txt: Contains responses mapped to message IDs.

    Frontend

    React App

    App.js: Main React component handling user input, WebSocket communication, and displaying responses.

    index.html: HTML template for the React app.

    License

    This project is licensed under the MIT License.

    Visit original content creator repository
    https://github.com/Shriram0463/Streaming-WebSockets-ID

  • anoddos

    Cú pháp câu lệnh: python3 anoddos.py [-h] [--target <URL>] [--method <HTTP>] [--time <time>] [--threads <threads>]

    Trong đó

    -h hay –help : hiển thị mục help của overload

    –target <URL> : mục tiêu mà bạn muốn nhắm tới

    –method <HTTP> : kiểu tấn công

    –time <giây> : Thời gian chạy tool

    — thread <luồng> : số luồng trên giây <tối đa 200>

    Ví dụ

    python3 anoddos.py --target vietnamconghoa.us --method HTTP --time 500 --thread 200

    Trong câu lệnh vừa rồi mình sử dụng Max thread xem web mình còn sống không và sau đây là kết quả

    Nhờ vậy mà mình biết là website của mình khá là dễ chết. Sau đây là cách để phòng chống các cuộc tấn công từ chối dịch vụ

    Các cách để phòng chống DDOS / DOS Biện pháp kĩ thuật Tăng cường khả năng xử lí hệ thống Tối ưu hóa thuật toán Nâng cấp máy chủ Nâng cấp băng thông Cài đặt đầy đủ các bản vá lỗi từ server Sử dụng tường lửa Công cụ phòng chống DDOS Dùng hệ thống thiết bị, phần mềm hoặc dịch vụ giám sát an toàn mạng Dùng thiết bị bảo vệ mạng có dịch vụ chống tấn công DDoS Tường lửa cứng hoặc tường lửa mềm

    Visit original content creator repository https://github.com/khanhhlq/anoddos
  • NUC8i5BEK-Hackintosh

    Visit original content creator repository
    https://github.com/Coool/NUC8i5BEK-Hackintosh

  • frontful-environment

    Frontful Environment

    frontful-environment is packaged provider of environment setup, scripts and developer utilities for server and browser Javascript application development. It’s environment setup provider for Frontful infrastructure.
    Reference integration can be found in frontful-todomvc application.

    Configuration of modern javascript applications using Babel and Webpack can be fun and exciting, it can also be time consuming and somewhat overwhelming. frontful-environment is packaged abstraction on top of Babel, Webpack and other great tools to provide simple yet configurable environment setup with essential features, good developer experience, abstraction and isolation. frontful-environment can streamline application development environment setup and help to focus on feature implementation instead of Javascript DevOps.

    Conceptually frontful-environment is similar to react-scripts in react-create-app. Difference lyes in that frontful-environment focuses not only on build for browser but also server, this results in core infrastructure for developing isomorphic applications, different feature set and mechanics.

    Features

    • ES6+ environment with ES Modules
    • Cold reload with state persistence and no HMR
      • Live reload on both server and browser code changes
      • JS, CSS and other imported resources are reloaded
      • Support for live reload of linked package changes
      • No separate server, no server restarts
    • Server and browser code is built into bundles
      • Server bundle excludes node_modules
      • Browser bundle is tree shakeable
      • Browser node_modules are placed into vendor bundle
      • Build is stored in memory for development by default
    • Isomorphic resource handling
    • Importing SVG as JSX React component
    • Multiple CSS styling approaches
      • CSS, SCSS and SASS
      • CSS Modules
      • Integrated autoprefixer
    • Environment configuration
    • Production build
    • Utilities
      • Linter
      • Source maps
      • Error parsing

    Mechanics

    frontful-environment consists of two aspects

    • Script – Script is installed under node_modules/.bin as frontful-environment and provides two variation
      • frontful-environment start – Starts application for development with live cold reload and package development assist. Utilities are working in NODE_ENV=development mode e.g. cold reload state persistence and error handling. Babel and Webpack are building server and browser bundles (in memory by default), these bundles get rebuilt and reloaded when code is changed.
      • frontful-environment build – Builds application for production and outputs optimized server and browser bundles to ./build folder. To run production build execute PORT=8000 node ./build/server. Babel and Webpack are working only during build process, when application is run Babel and Webpack are not triggered. Certain utilities are disabled or working in NODE_ENV=production mode e.g. cold reload state persistence and error handling
    • Utilities – Provides utilities to access and use certain aspects of frontful-environment. To use these utilities import environment from 'frontful-environment'.
      • environment.assets – Get bundle absolute mount path e.g. js.main, js.vendor, css.main, css.vendor.
      • environment.coldreload – Utilities for setting serializer and deserializer handlers and accessing persisted state
      • environment.error – Utilities for error parser() and getHandler() Express.js style error handler middleware.
      • environment.server – Get current http server instance
      • environment.listener – Get current http server listener instance

    Installation

    # Using yarn
    yarn add frontful-environment
    # or npm
    npm install -s frontful-environment

    Integration

    By default frontful-environment has only one assumption/requirement, that you have two entry points to your applications

    • ./src/browser/index.js – Entry point for browser bundle
    • ./src/server/index.js – Entry point for server bundle. Server entry must exports http request handler or Express.js style application instance.

    To change default entry point file names read section on Configuration.

    Add start and build scripts to package.json

    // package.json
    {
      "scripts": {
        "build": "frontful-environment build",
        "start": "frontful-environment start"
      }
    }

    Ensure that entry point file for browser exists e.g. ./src/browser/index.js.

    Ensure that entry point file for server exists e.g. ./src/server/index.js and that it exports http server request handler or Express.js style instance

    import express from 'express'
    const app = express()
    app.use(...)
    export default app

    To start application for development run yarn start or npm run start.
    To build application for production run yarn build or npm run build.
    To start application for production after build run PORT=8000 node ./build/server.

    For extended integration, e.g. enabling cold reload state persistence or getting mounted path of built assets and bundles, read section on Utilities

    Configuration

    In package.json add frontful.environment property. Configuration can be done in several ways as provided by frontful-config, bellow are two examples.

    Value of frontful.environment property can be configuration object with property structure as described in configuration defaults/schema

    // package.json
    {
      "frontful": {
        "environment": {
          ...
        }
      }
    }

    Value of frontful.environment property can also be path to ES5 .js file that provides configuration

    // package.json
    {
      "frontful": {
        "environment": "./config.environment.js"
      }
    }

    // config.environment.js
    module.exports = {
      ...
    }

    Babel configuration

    frontful-environment uses babel-preset-frontful as its Babel preset. To customize babel preset refer to babel-preset-frontful Configuration

    Webpack configuration

    To configure Webpack, refer to server.webpack and browser.webpack properties in configuration defaults/schema. Both have two additional properties

    Utilities

    bundle

    To get build bundle absolute mount path use environment.bundle utility object

    import environment from 'frontful-environment'
    const bundle = environment.bundle
    const html = `
      <html>
        <head>
          <link rel="stylesheet" href="https://github.com/frontful/${bundle.css.vendor}">
          <link rel="stylesheet" href="https://github.com/frontful/${bundle.css.main}">
        </head>
        <body>
          <div id="app"></div>
          <script src="https://github.com/frontful/${bundle.js.vendor}"></script>
          <script src="https://github.com/frontful/${bundle.js.main}"></script>
        </body>
      </html>
    `

    coldreload

    Depending on what part of code changes server, browser or both, respective bundles get rebuilt and page in the browser is automatically reloaded.

    By default client state is lost. To persist and revive application state use environment.coldreload utility object

    // In browser
    import environment from 'frontful-environment'
    // Return serialized JSON state that needs to be persisted
    environment.coldreload.serializer = () => {
      return models.serialize()
    }
    // Deserialize persisted JSON state to application model
    // If cold state is deserialized on server this can be omitted
    environment.coldreload.deserializer = (state) => {
      models.deserialize(state)
    }

    // On server
    import environment from 'frontful-environment'
    // Check if serialized state exists and deserialize it to your application model
    // For isomorphic apps using React this will ensure that DOM rendered on server matches client DOM
    if (environment.coldreload.state) {
      models.deserialize(environment.coldreload.state)
    }

    This mechanic should be compatible with any state management system that support serialization and deserialization, e.g Redux or Mobx.

    error

    frontful-environment provides cleaned up Error output for build errors. Same Error parsing can be had in your application by using environment.error utility object.
    This utility works only on server.

    import environment from 'frontful-environment'
    // Parse error
    const error = environment.error.parser(e)
    // Log error in with colors
    console.log(error.colorful)
    // Log error without colors
    console.log(error.string)
    
    // To format Express.js errors, mount error handler `Express` middleware as las middleware in application
    app.use(environment.error.getHandler())

    server

    To access http server instance use environment.server getter utility

    import environment from 'frontful-environment'
    const server = environment.server

    listener

    To access http servers listener instance use environment.listener getter utility

    import environment from 'frontful-environment'
    const listener = environment.listener

    Assets

    Assets can be referenced in few ways.

    By absolute path to assets. Mount asset folder, then reference asset on its absolute mounted path.

    import express from 'express'
    const app = express()
    app.use('/assets', express.static('assets', {maxAge: '7d'}))

    .container {
      background-image: url(/assets/image.png);
    }

    By importing asset in you Javascript code with extension included. Works with svg, png, jpg, jpeg, gif and ico assets.

    import image from './image.png'
    export default () => (
      <img src={image} />
    )

    By using relative path in CSS. Works with svg, png, jpg, jpeg, gif and ico assets.

    .container {
      background-image: url(./image.png);
    }

    If assets are references other than by its absolute path and its file size is less than 1kB its content will be inlined.

    CSS

    frontful-environment supports standard CSS, SCSS, SASS, as well as CSS Modules for each of these style approaches.
    Frontful infrastructure also provides ability to style application using CSS in JS approach, for more details refer to frontful-style

    Standard CSS, SCSS, SASS

    // Browser
    import `./style.scss`
    CSS Modules

    CSS Module support is added by adding .module prefix to style extension, e.g. Component.module.css or Component.module.scss, importing CSS module in your Javascript code.

    /* Component.module.css */
    .container {
      color: green;
    }

    import style from `./Component.module.css`
    export default () => (
      <div className={style.container}>
        Hello CSS Modules
      </div>
    )

    SVG

    Apart from using SVG as any other asset by directly referencing or importing it, SVG can be used in React app as React component.
    For SVG to be interpreted as React component, .svg extension must be prefixed with .jsx e.g. icon.jsx.svg

    import Icon from './assets/icon.jsx.svg'
    export default () => (
      <div>
        <Icon />
      </div>
    )

    Package development assist

    For more details on package development refer to package development assist

    Visit original content creator repository
    https://github.com/frontful/frontful-environment