commit fa2489844a40bc81b1a9cde0e9aa5cfa7c83a30b Author: mya Date: Thu Jul 4 13:49:39 2024 -0500 epoch diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..79a09ec --- /dev/null +++ b/.dockerignore @@ -0,0 +1,5 @@ +node_modules + +docker-compose.yaml + +*.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..5f47179 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +# EditorConfig is awesome: https://editorconfig.org + +# top-most EditorConfig file +root = true + +# Unix-style newlines with a newline ending every file +[*] +end_of_line = lf +insert_final_newline = true +max_line_length = 120 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4781706 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +# Editor configurations +.idea/ + +# NodeJS +node_modules/ + +# Generated code +lib/**/gen/ diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..be2f144 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,2 @@ +package.json +pnpm-lock.yaml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f36a7b7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,662 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + + Copyright (C) {{ year }} {{ organization }} + + 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 . + +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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0b7f8a5 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Company + +This project aims to provide a comprehensive starter repository for companies seeking to leverage a monorepository. To +better understand the rationale that went into the initial technology selection for this repository,see the +[Initial Technology Selection][] decision document. Feel free to add, remove, or replace any technology as you see fit +for your organization. + +[Initial Technology Selection]: docs/internal/decisions/internal-technology-selection.md + +### Directory Structure + +Credit where credit is due. This repository structure is largely based on the one described in +[this blog post][structure-a-monorepo], but with a handful of personal modifications. I've come to really enjoy this +layout and it takes a lot of things into consideration early on that you'll likely thank yourself for later (e.g. +internationalization). + +[structure-a-monorepo]: https://lucapette.me/writing/how-to-structure-a-monorepo/ + +- [API Definitions](api) - API specifications defined in your specification of choice (e.g protocol buffers, graphql). +- [Assets](assets) - Internationalization assets and various media used throughout the product. +- [Documentation](docs) - All documentation related to the product. Internal, external, designs, runbooks, etc. +- [Infrastructure](infra) - You got it... your infrastructure as code solutions. +- [Legal](legal) - Things related to legal, including common policies. +- [Libraries](lib) - Common libraries shared by the different components of the platform. +- [Platform](platform) - The various systems that compose the platform and are deployed to servers or in the cloud. +- [User Interfaces](ui) - The different interfaces that we build out and expose to the end user or internally. + +## License + +```text +Copyright (C) 2024 Company + +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 . +``` diff --git a/api/README.md b/api/README.md new file mode 100644 index 0000000..aa5c7d2 --- /dev/null +++ b/api/README.md @@ -0,0 +1,17 @@ +# API + +This directory should contain your various API specifications. + +- [gRPC][] and [Protocol Buffers][] +- [GraphQL][] +- [JSON Schema][] +- [Apache Thrift][] +- [Facebook Thrift][] +- ... + +[gRPC]: https://grpc.io/ +[Protocol Buffers]: https://protobuf.dev/ +[GraphQL]: https://graphql.org/ +[JSON Schema]: https://json-schema.org/ +[Apache Thrift]: https://thrift.apache.org/ +[Facebook Thrift]: https://github.com/facebook/fbthrift diff --git a/api/package.json b/api/package.json new file mode 100644 index 0000000..580a472 --- /dev/null +++ b/api/package.json @@ -0,0 +1,13 @@ +{ + "name": "api", + "version": "0.0.0", + "description": "API specifications defined in your specification of choice.", + "private": true, + "license": "AGPL-3.0-only", + "devDependencies": {}, + "scripts": { + "format": "", + "lint": "", + "clean": "" + } +} diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 0000000..2bd8d76 --- /dev/null +++ b/assets/README.md @@ -0,0 +1,27 @@ +# Assets + +Assets contains components that will be uploaded to a CDN. This includes translations to different languages +(internationalization), images used across the documentation and product, videos, fonts, or any other assets you need +distributed on a CDN. + +## Internationalization + +Internationalization helps products reach a wider audience by supporting various languages. Common tasks that may be +performed in this package might include: + +- linting for common spelling mistakes +- ensure ids meet a certain convention +- extract strings that need to be sent out for machine translations + +Internationalization assets can be found in the `i18n` directory. + +## Images + +Images are used in a variety of different places across the site. We often need to upload these assets to a cdn. Common +tasks that may be performed in this package might include: + +- resizing images at different sizes +- converting images between different formats +- lint the files and ensure the exif data is stripped + +Images can be found in the `images` directory. diff --git a/assets/i18n/package.json b/assets/i18n/package.json new file mode 100644 index 0000000..54e06f3 --- /dev/null +++ b/assets/i18n/package.json @@ -0,0 +1,13 @@ +{ + "name": "assets-i18n", + "version": "0.0.0", + "description": "Internationalization assets used throughout the product.", + "private": true, + "license": "AGPL-3.0-only", + "devDependencies": {}, + "scripts": { + "format": "", + "lint": "", + "clean": "" + } +} diff --git a/assets/images/package.json b/assets/images/package.json new file mode 100644 index 0000000..ac963cd --- /dev/null +++ b/assets/images/package.json @@ -0,0 +1,13 @@ +{ + "name": "assets-images", + "version": "0.0.0", + "description": "Media used throughout the product.", + "private": true, + "license": "AGPL-3.0-only", + "devDependencies": {}, + "scripts": { + "format": "", + "lint": "", + "clean": "" + } +} diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..4a0fa60 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,52 @@ +# conventions for volumes on docker is to use underscore +volumes: + pnpm_cache: {} + +# conventions for services in docker is to use hyphen +services: + devtools: + image: monorepo/devtools:latest + build: + context: . + dockerfile_inline: | + FROM golang:latest AS go + ENV GOBIN /go/bin + + RUN go install github.com/nokia/addlicense@latest + RUN go install filippo.io/mkcert@latest + + FROM node:20 + WORKDIR /opt/monorepo + VOLUME /opt/pnpm + + # pnpm + RUN npm install -g pnpm && pnpm config set store-dir /opt/pnpm + + # go binaries + COPY --from=go /go/bin/addlicense /usr/bin/addlicense + COPY --from=go /go/bin/mkcert /usr/bin/mkcert + + # jq + RUN apt update && apt upgrade -y + RUN apt install -y jq + + # cargo + RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y + + # node + COPY package.json package.json + COPY pnpm-lock.yaml pnpm-lock.yaml + COPY pnpm-workspace.yaml pnpm-workspace.yaml + COPY api/package.json api/package.json + COPY assets/i18n/package.json assets/i18n/package.json + COPY assets/images/package.json assets/images/package.json + COPY docs/internal/package.json docs/internal/package.json + COPY docs/public/package.json docs/public/package.json + COPY infra/charts/package.json infra/charts/package.json + COPY infra/images/package.json infra/images/package.json + COPY infra/provisioning/package.json infra/provisioning/package.json + + ENTRYPOINT "/bin/bash" + command: pnpm install + volumes: + - pnpm_cache:/opt/pnpm diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..8c6b07a --- /dev/null +++ b/docs/README.md @@ -0,0 +1,32 @@ +# Documentation + +Documentation has a few different scopes that everyone should be aware of. Internal documentation is documentation that +focuses on things relevant to employees of the company. + +## Internal + +> :bangbang: **This documentation is private to the company.** + +Internal documentation doesn't need to be as fancy as it's public facing counter-part. + +- [Architecture](internal/ARCHITECTURE.md) +- [Developers Guide](internal/DEVELOPING.md) + +### Decisions + +- [Template](internal/decisions/_template.md) +- [Initial Technology Selection](internal/decisions/initial-technology-selection.md) + +### Designs + +- [Template](internal/designs/_template.md) + +### Runbooks + +- [Runbook Template](internal/runbooks/_template.md) + +## Public + +> :bangbang: **This documentation is public, and accessible to end-users.** + +Most projects implement [public](public) documentation using solutions like Jekyll, Hugo, and Astro. diff --git a/docs/internal/ARCHITECTURE.md b/docs/internal/ARCHITECTURE.md new file mode 100644 index 0000000..c79bec1 --- /dev/null +++ b/docs/internal/ARCHITECTURE.md @@ -0,0 +1 @@ +# Architecture diff --git a/docs/internal/DEVELOPING.md b/docs/internal/DEVELOPING.md new file mode 100644 index 0000000..3de2f3b --- /dev/null +++ b/docs/internal/DEVELOPING.md @@ -0,0 +1,25 @@ +# Developers Guide + +All developer dependencies have been built into a simple container image. Using Docker, or your preferred runtime of +choice, you can quickly spin up a shell with all the needed developer tooling. + +```shell +# install pnpm for better monorepo support +npm install -g pnpm +pnpm config set store-dir $HOME/.pnpm + +# spin up a shell +pnpm shell +``` + +### Targets + +`pnpm packages` will output a list of all the packages within this repository. + +`pnpm clean` will clean up any temporary installs and generated code. + +`pnpm gen` generates code for the API layer. + +`pnpm format` ensures that projects adhere to proper code style and makes any necessary modifications it needs to. + +`pnpm lint` ensures that projects adhere to proper code style and fails if it does not. diff --git a/docs/internal/decisions/_template.md b/docs/internal/decisions/_template.md new file mode 100644 index 0000000..f311024 --- /dev/null +++ b/docs/internal/decisions/_template.md @@ -0,0 +1,9 @@ +--- +# front-matter +--- + +# Decision Template + +- Are there any existing solutions that we can purchase? +- Are there any open source solutions we can run ourselves? +- What should leadership know if we have to build this ourselves? diff --git a/docs/internal/decisions/initial-technology-selection.md b/docs/internal/decisions/initial-technology-selection.md new file mode 100644 index 0000000..8b8be1f --- /dev/null +++ b/docs/internal/decisions/initial-technology-selection.md @@ -0,0 +1,58 @@ +--- +# front-matter +--- + +# Initial Technology Selection + +The technology selected in this project were largely based on my own personal usage and experience. Feel free to drop +or replace technologies where you see fit. I tried to keep things it a minimum so there wasn't a lot to consider. + +## Docker + +[Docker][] is a powerful containerization technology that allows you to encapsulate all your dependencies into a single +isolated unit. I've been leveraging Docker in development environments since 2014 and have had huge success with making +developer environments, richer and easier to work with through containers. Docker makes it easy to encapsulate tools +into a single location, removing the need to manage complicated local provisioning scripts that spans various operating +systems. + +[Docker]: https://www.docker.com/products/docker-desktop/ + +## NodeJS + +According to [IEEE][], JavaScript was the 5th most popular programming language used in projects beating out languages +like C#, Go, and many others. When it comes to jobs, it's the 4th most popular language that organizations hire for, +and is the 3rd when it comes to trending libraries. + +A large number of projects are built using JavaScript or one of its variants (e.g [TypeScript][]). Many projects +feature "progressive web apps" or "single page applications" to provide a richer client side experience. + +In the early days of mobile application programming, writing iOS and Android applications came with a lot of challenge +and cost. Companies typically had two teams, building out native experiences for both platforms. As a result, features +would often drift between the different types of devices. Through systems like [Apache Cordova][], JavaScript made its +way to mobile devices. While it initially came at a fairly high performance cost, Cordova enabled JavaScript developers +to write mobile applications without needing to learn a new programming language. Over time, the community has improved +the performance of these types of applications by leveraging new technologies and capabilities. + +Eventually, tools like [Electron][] and [Tauri][] brought JavaScript to the desktop. Now, Windows, OSX, and Linux +desktop applications could be written using the + +Outside it's use in projects, NodeJS and NPM include a large number of useful utility packages, such as `prettier` and +`concurrently` which makes it great for formatting and linting common file formats (such as javascript, css/less/sass, +html, json, graphql, markdown, and yaml). As a result, I often like having NPM at the root to be able to manage the +versions of these tools in the repository itself. + +[IEEE]: https://spectrum.ieee.org/the-top-programming-languages-2023 +[TypeScript]: https://www.typescriptlang.org/ +[Apache Cordova]: https://cordova.apache.org/ +[Electron]: https://www.electronjs.org/ +[Tauri]: https://tauri.app/ + +### PNPM + +When working with multiple, large NodeJS code bases, multi-package management becomes a necessity. [LernaJS][] was an +early multiple package management solution. While a great initial solution, it lacked a lot features that came with +future solutions such as [PNPM][]. PNPM not only makes it easy to manage monorepos while also improving the storage of +dependencies in the local file system. + +[LernaJS]: https://lerna.js.org/ +[PNPM]: https://pnpm.io/ diff --git a/docs/internal/designs/_template.md b/docs/internal/designs/_template.md new file mode 100644 index 0000000..3c60700 --- /dev/null +++ b/docs/internal/designs/_template.md @@ -0,0 +1,8 @@ +--- +# front-matter +--- + +# Design Template + +- What are we building? +- Why did we decide to build it? (This can link to a previous decision document.) diff --git a/docs/internal/package.json b/docs/internal/package.json new file mode 100644 index 0000000..8d41370 --- /dev/null +++ b/docs/internal/package.json @@ -0,0 +1,13 @@ +{ + "name": "docs-internal", + "version": "0.0.0", + "description": "Internal employee-facing documentation.", + "private": true, + "license": "AGPL-3.0-only", + "devDependencies": {}, + "scripts": { + "format": "", + "lint": "", + "clean": "" + } +} diff --git a/docs/internal/runbooks/_outage.md b/docs/internal/runbooks/_outage.md new file mode 100644 index 0000000..983f2e1 --- /dev/null +++ b/docs/internal/runbooks/_outage.md @@ -0,0 +1,29 @@ +--- +# front-matter +--- + +# Production Outage Scenario Template + +## Symptoms + +Describe the current state of the system. + +### Context + +Provide context about the systems and the potential impact on the end users. + +### Troubleshooting + +Provide any steps to help users troubleshoot the system and gather any additional information. + +## Remediation Steps + +1. First step to remediation +2. Second step +3. ... +4. Finally, ... + +## Next Steps + +Branching point. +If this guide couldn't help the user diagnose or fix the problem, possibly point them at related runbooks to help remediate the problem. diff --git a/docs/internal/runbooks/_template.md b/docs/internal/runbooks/_template.md new file mode 100644 index 0000000..cff0c43 --- /dev/null +++ b/docs/internal/runbooks/_template.md @@ -0,0 +1,81 @@ +--- +# front-matter +--- + +# Runbook Template + +Template credit goes to [CatieM20][]. If you haven't seen their talk on [Tackling Alert Fatigue][] yet, go give it a +watch. I've made a handful of modifications to include some site reliability engineering geared content. + +[CatieM20]: https://github.com/CaitieM20/Talks/blob/master/TacklingAlertFatigue/runbook.md + +## General + +A quick description of the services. 1 to 2 sentences max. Why does this service matter? What is it's core +functionality? What Features does it provide users? + +## Failure Mode and Effect Analysis + +[FMEA][] is a method of failure analysis that helps teams create reliable systems and develop comprehensive on-call +response patterns. + +[FMEA]: https://en.wikipedia.org/wiki/Failure_mode_and_effects_analysis + +| Service | Failure Mode | Possible Cause | Effects | Probability (P) | Severity (S) | Detection (D) | Risk | +| :-------- | :------------------- | :-------------- | :-------------------------------- | :-------------- | :------------ | :------------ | :--- | +| DockerHub | Outage / Unreachable | DockerHub DDOSd | Cannot update or deploy extractor | remote (B) | no effect (I) | high | low | + +### Production Outage Scenarios + +- [Example scenario](_outage.md) + +## Dashboards + +Links to the Dashboards for this service. + +## Alerts + +Links to the Alerts for this service + +For Every Alert there should be a corresponding section in alphabetical order + +### Alert Title + +Alert Description: Why do we have this alert? What does it mean? What is typically the cause of this alert? + +#### Impact to Customers: + +How does this situation impact our customers? If the customers are not being impacted, this is a good indicator that the alert can be deleted. + +#### Remediation Steps: + +Checklist manifesto style steps for how to resolve this alert. A person who has never worked on our stack should be able to follow these steps and remediate the incident. If it cannot be remediated, include escalation steps here. + +1. Do this +2. Check this graph +3. Do this thing +4. Do this other thing +5. Verify service has recovered + +## Deployment + +How do you deploy this services. Favor Checklist manifesto style lists here as well. + +1. Do this thing +2. Do this other thing +3. Finally do this thing + +### Canary Deploy + +Instructions on how to do a Canary Deployment + +1. Do this canary thing +2. another canary task + +### Rollback Deploy + +Instructions on how to Rollback a Deploy. + +1. Get the rollback build here +2. Do this thing +3. Do this other thing. diff --git a/docs/public/package.json b/docs/public/package.json new file mode 100644 index 0000000..b95e521 --- /dev/null +++ b/docs/public/package.json @@ -0,0 +1,13 @@ +{ + "name": "docs-public", + "version": "0.0.0", + "description": "External public-facing documentation.", + "private": true, + "license": "AGPL-3.0-only", + "devDependencies": {}, + "scripts": { + "format": "", + "lint": "", + "clean": "" + } +} diff --git a/infra/README.md b/infra/README.md new file mode 100644 index 0000000..a9e8a10 --- /dev/null +++ b/infra/README.md @@ -0,0 +1,13 @@ +# Infrastructure + +## Charts + +Helm charts for deploying containers to Kubernetes. + +## Images + +Container and machine image definitions. + +## Provisioning + +Provision infrastructure using common infrastructure as code solutions. diff --git a/infra/charts/package.json b/infra/charts/package.json new file mode 100644 index 0000000..17979cf --- /dev/null +++ b/infra/charts/package.json @@ -0,0 +1,13 @@ +{ + "name": "infra-charts", + "version": "0.0.0", + "description": "Helm charts for deploying containers to Kubernetes.", + "private": true, + "license": "AGPL-3.0-only", + "devDependencies": {}, + "scripts": { + "format": "", + "lint": "", + "clean": "" + } +} diff --git a/infra/images/package.json b/infra/images/package.json new file mode 100644 index 0000000..2ea71d8 --- /dev/null +++ b/infra/images/package.json @@ -0,0 +1,13 @@ +{ + "name": "infra-images", + "version": "0.0.0", + "description": "Container and machine image definitions.", + "private": true, + "license": "AGPL-3.0-only", + "devDependencies": {}, + "scripts": { + "format": "", + "lint": "", + "clean": "" + } +} diff --git a/infra/provisioning/package.json b/infra/provisioning/package.json new file mode 100644 index 0000000..7d4a8ed --- /dev/null +++ b/infra/provisioning/package.json @@ -0,0 +1,13 @@ +{ + "name": "infra-provisioning", + "version": "0.0.0", + "description": "Provision infrastructure using common infrastructure as code solutions.", + "private": true, + "license": "AGPL-3.0-only", + "devDependencies": {}, + "scripts": { + "format": "", + "lint": "", + "clean": "" + } +} diff --git a/legal/README.md b/legal/README.md new file mode 100644 index 0000000..17241a3 --- /dev/null +++ b/legal/README.md @@ -0,0 +1,9 @@ +# Legal + +The legal team has full control over the content within this directory. + +## Policies + +- [Privacy Policy](policies/privacy.md) +- [Technology Use](policies/technologies.md) +- [Terms of Service](policies/terms.md) diff --git a/legal/addlicense.yaml b/legal/addlicense.yaml new file mode 100644 index 0000000..29e0a49 --- /dev/null +++ b/legal/addlicense.yaml @@ -0,0 +1,17 @@ +# -- Ignore common file types, such as configuration files. +ignorePaths: + - ".idea/*" + - "**/gen/**" + - "*.yaml" + +# -- Enables support for custom file extensions that aren't natively supported by addlicense. +fileExtensions: + [] + # - extensions: [".mc"] + # top: "" + # mid: "// " + # bot: "" + # - extensions: [".xml"] + # top: "" diff --git a/legal/header.txt b/legal/header.txt new file mode 100644 index 0000000..9e33089 --- /dev/null +++ b/legal/header.txt @@ -0,0 +1,2 @@ +Copyright (C) {{ .Year }} Company +SPDX-License-Identifier: AGPL-3.0-only diff --git a/legal/policies/privacy.md b/legal/policies/privacy.md new file mode 100644 index 0000000..6e1f6fa --- /dev/null +++ b/legal/policies/privacy.md @@ -0,0 +1,3 @@ +# Privacy Policy + +Have your legal team fill this in. diff --git a/legal/policies/technologies.md b/legal/policies/technologies.md new file mode 100644 index 0000000..c71c61c --- /dev/null +++ b/legal/policies/technologies.md @@ -0,0 +1,3 @@ +# Technology Use + +Have your legal team fill this in. diff --git a/legal/policies/terms.md b/legal/policies/terms.md new file mode 100644 index 0000000..0f0084d --- /dev/null +++ b/legal/policies/terms.md @@ -0,0 +1,3 @@ +# Terms of Service + +Have your legal team fill this in. diff --git a/lib/README.md b/lib/README.md new file mode 100644 index 0000000..bffc3a8 --- /dev/null +++ b/lib/README.md @@ -0,0 +1,15 @@ +# Library + +Your library contains shared code that can be used across multiple services. This is most-often used when code +generating API definitions. For example, gRPC will convert protocol buffer definitions into different language +implementations, simplifying the process of writing client and server implementations. Similarly, GraphQL has +some fairly extensive support for code-generation. + +```shell +|- lib + |- {language} + | |- {package} + | | |- package.json + | | |- # ... + | +``` diff --git a/package.json b/package.json new file mode 100644 index 0000000..9a8d033 --- /dev/null +++ b/package.json @@ -0,0 +1,28 @@ +{ + "name": "monorepo", + "version": "0.0.0", + "private": true, + "license": "AGPL-3.0-only", + "engines": { + "node": ">=18", + "pnpm": ">=9" + }, + "devDependencies": { + "concurrently": "^8.2.2", + "prettier": "^3.3.2" + }, + "scripts": { + "packages": "git ls-files '**/package.json' | xargs jq -Mr '[.name, .version, .description] | @csv' | tr -d '\"' | column -s, -t", + "seq": "concurrently --maxProcesses 1", + "clean": "pnpm -r clean && concurrently --maxProcesses 1 'pnpm:*:clean'", + "node:clean": "rm -rf node_modules", + "format": "pnpm -r format && concurrently --maxProcesses 1 'pnpm:*:format'", + "lint": "pnpm -r lint && concurrently --maxProcesses 1 'pnpm:*:lint'", + "preshell": "docker compose up --build devtools", + "shell": "docker run --rm -it -v .:/opt/monorepo -v monorepo_pnpm_cache:/opt/pnpm monorepo/devtools", + "legal:format": "addlicense -f legal/header.txt -config legal/addlicense.yaml -s .", + "legal:lint": "addlicense -f legal/header.txt -config legal/addlicense.yaml -s -check .", + "codestyle:format": "prettier --write .", + "codestyle:lint": "prettier --check ." + } +} diff --git a/platform/README.md b/platform/README.md new file mode 100644 index 0000000..37c0175 --- /dev/null +++ b/platform/README.md @@ -0,0 +1,22 @@ +# Platform + +By default, `pnpm` is setup to track any subdirectory of the `platform` as a `pnpm` workspace. To help illustrate this, +let us consider the example directory structure below. It shows how we might include both off the shelf solutions and +internally developed one. + +```shell +|- platform + |- identity + | |- ## off the shelf, identity service + | + |- billing + | |- ## off the shelf, billing service + | + |- product + | |- ## product specific service + | + |- metrics + | |- ## business intelligence and operations solution + | + |- ## ... +``` diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml new file mode 100644 index 0000000..10a1851 --- /dev/null +++ b/pnpm-lock.yaml @@ -0,0 +1,265 @@ +lockfileVersion: '9.0' + +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + +importers: + + .: + devDependencies: + concurrently: + specifier: ^8.2.2 + version: 8.2.2 + prettier: + specifier: ^3.3.2 + version: 3.3.2 + + api: {} + + assets/i18n: {} + + assets/images: {} + + docs/internal: {} + + docs/public: {} + + infra/charts: {} + + infra/images: {} + + infra/provisioning: {} + +packages: + + '@babel/runtime@7.24.7': + resolution: {integrity: sha512-UwgBRMjJP+xv857DCngvqXI3Iq6J4v0wXmwc6sapg+zyhbwmQX67LUEFrkK5tbyJ30jGuG3ZvWpBiB9LCy1kWw==} + engines: {node: '>=6.9.0'} + + ansi-regex@5.0.1: + resolution: {integrity: sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==} + engines: {node: '>=8'} + + ansi-styles@4.3.0: + resolution: {integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==} + engines: {node: '>=8'} + + chalk@4.1.2: + resolution: {integrity: sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==} + engines: {node: '>=10'} + + cliui@8.0.1: + resolution: {integrity: sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==} + engines: {node: '>=12'} + + color-convert@2.0.1: + resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==} + engines: {node: '>=7.0.0'} + + color-name@1.1.4: + resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==} + + concurrently@8.2.2: + resolution: {integrity: sha512-1dP4gpXFhei8IOtlXRE/T/4H88ElHgTiUzh71YUmtjTEHMSRS2Z/fgOxHSxxusGHogsRfxNq1vyAwxSC+EVyDg==} + engines: {node: ^14.13.0 || >=16.0.0} + hasBin: true + + date-fns@2.30.0: + resolution: {integrity: sha512-fnULvOpxnC5/Vg3NCiWelDsLiUc9bRwAPs/+LfTLNvetFCtCTN+yQz15C/fs4AwX1R9K5GLtLfn8QW+dWisaAw==} + engines: {node: '>=0.11'} + + emoji-regex@8.0.0: + resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==} + + escalade@3.1.2: + resolution: {integrity: sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==} + engines: {node: '>=6'} + + get-caller-file@2.0.5: + resolution: {integrity: sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==} + engines: {node: 6.* || 8.* || >= 10.*} + + has-flag@4.0.0: + resolution: {integrity: sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==} + engines: {node: '>=8'} + + is-fullwidth-code-point@3.0.0: + resolution: {integrity: sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==} + engines: {node: '>=8'} + + lodash@4.17.21: + resolution: {integrity: sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==} + + prettier@3.3.2: + resolution: {integrity: sha512-rAVeHYMcv8ATV5d508CFdn+8/pHPpXeIid1DdrPwXnaAdH7cqjVbpJaT5eq4yRAFU/lsbwYwSF/n5iNrdJHPQA==} + engines: {node: '>=14'} + hasBin: true + + regenerator-runtime@0.14.1: + resolution: {integrity: sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==} + + require-directory@2.1.1: + resolution: {integrity: sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==} + engines: {node: '>=0.10.0'} + + rxjs@7.8.1: + resolution: {integrity: sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg==} + + shell-quote@1.8.1: + resolution: {integrity: sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA==} + + spawn-command@0.0.2: + resolution: {integrity: sha512-zC8zGoGkmc8J9ndvml8Xksr1Amk9qBujgbF0JAIWO7kXr43w0h/0GJNM/Vustixu+YE8N/MTrQ7N31FvHUACxQ==} + + string-width@4.2.3: + resolution: {integrity: sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==} + engines: {node: '>=8'} + + strip-ansi@6.0.1: + resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==} + engines: {node: '>=8'} + + supports-color@7.2.0: + resolution: {integrity: sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==} + engines: {node: '>=8'} + + supports-color@8.1.1: + resolution: {integrity: sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==} + engines: {node: '>=10'} + + tree-kill@1.2.2: + resolution: {integrity: sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==} + hasBin: true + + tslib@2.6.3: + resolution: {integrity: sha512-xNvxJEOUiWPGhUuUdQgAJPKOOJfGnIyKySOc09XkKsgdUV/3E2zvwZYdejjmRgPCgcym1juLH3226yA7sEFJKQ==} + + wrap-ansi@7.0.0: + resolution: {integrity: sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==} + engines: {node: '>=10'} + + y18n@5.0.8: + resolution: {integrity: sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==} + engines: {node: '>=10'} + + yargs-parser@21.1.1: + resolution: {integrity: sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==} + engines: {node: '>=12'} + + yargs@17.7.2: + resolution: {integrity: sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==} + engines: {node: '>=12'} + +snapshots: + + '@babel/runtime@7.24.7': + dependencies: + regenerator-runtime: 0.14.1 + + ansi-regex@5.0.1: {} + + ansi-styles@4.3.0: + dependencies: + color-convert: 2.0.1 + + chalk@4.1.2: + dependencies: + ansi-styles: 4.3.0 + supports-color: 7.2.0 + + cliui@8.0.1: + dependencies: + string-width: 4.2.3 + strip-ansi: 6.0.1 + wrap-ansi: 7.0.0 + + color-convert@2.0.1: + dependencies: + color-name: 1.1.4 + + color-name@1.1.4: {} + + concurrently@8.2.2: + dependencies: + chalk: 4.1.2 + date-fns: 2.30.0 + lodash: 4.17.21 + rxjs: 7.8.1 + shell-quote: 1.8.1 + spawn-command: 0.0.2 + supports-color: 8.1.1 + tree-kill: 1.2.2 + yargs: 17.7.2 + + date-fns@2.30.0: + dependencies: + '@babel/runtime': 7.24.7 + + emoji-regex@8.0.0: {} + + escalade@3.1.2: {} + + get-caller-file@2.0.5: {} + + has-flag@4.0.0: {} + + is-fullwidth-code-point@3.0.0: {} + + lodash@4.17.21: {} + + prettier@3.3.2: {} + + regenerator-runtime@0.14.1: {} + + require-directory@2.1.1: {} + + rxjs@7.8.1: + dependencies: + tslib: 2.6.3 + + shell-quote@1.8.1: {} + + spawn-command@0.0.2: {} + + string-width@4.2.3: + dependencies: + emoji-regex: 8.0.0 + is-fullwidth-code-point: 3.0.0 + strip-ansi: 6.0.1 + + strip-ansi@6.0.1: + dependencies: + ansi-regex: 5.0.1 + + supports-color@7.2.0: + dependencies: + has-flag: 4.0.0 + + supports-color@8.1.1: + dependencies: + has-flag: 4.0.0 + + tree-kill@1.2.2: {} + + tslib@2.6.3: {} + + wrap-ansi@7.0.0: + dependencies: + ansi-styles: 4.3.0 + string-width: 4.2.3 + strip-ansi: 6.0.1 + + y18n@5.0.8: {} + + yargs-parser@21.1.1: {} + + yargs@17.7.2: + dependencies: + cliui: 8.0.1 + escalade: 3.1.2 + get-caller-file: 2.0.5 + require-directory: 2.1.1 + string-width: 4.2.3 + y18n: 5.0.8 + yargs-parser: 21.1.1 diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml new file mode 100644 index 0000000..36d8ebb --- /dev/null +++ b/pnpm-workspace.yaml @@ -0,0 +1,8 @@ +packages: + - "api" + - "assets/*" + - "docs/*" + - "infra/*" + - "lib/*/*" + - "platform/*" + - "ui/*" diff --git a/ui/README.md b/ui/README.md new file mode 100644 index 0000000..95a1335 --- /dev/null +++ b/ui/README.md @@ -0,0 +1,22 @@ +# User Interfaces + +By default, `pnpm` is setup to track any subdirectory of the `ui` as a `pnpm` workspace. To help illustrate this, let +us consider the example directory structure below. It illustrates how you may have several, independently managed +user interfaces, including command line interfaces. + +```shell +|- ui + |- mobile + | |- ## react native app + | + |- storefront + | |- ## ... + | + |- backstage + | |- ## ... + | + |- cli + | |- # ... + | + |- ## ... +```