[
{
"path": ".dockerignore",
"content": "node_modules\n.next\n.vscode\n.git"
},
{
"path": ".eslintrc.json",
"content": "{\n \"extends\": \"next/core-web-vitals\",\n \"rules\": {\n \"react/no-unescaped-entities\": \"off\"\n }\n}\n"
},
{
"path": ".gitignore",
"content": "# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.\n\n# dependencies\n/node_modules\n/.pnp\n.pnp.js\n\n# testing\n/coverage\n\n# next.js\n/.next/\n/out/\n\n# production\n/build\n\n# misc\n.DS_Store\n*.pem\n\n# debug\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\n\n# local env files\n.env*.local\n\n# vercel\n.vercel\n\n# typescript\n*.tsbuildinfo\nnext-env.d.ts\n"
},
{
"path": ".prettierignore",
"content": ".next\npublic/fonts/fonts.css"
},
{
"path": "Dockerfile",
"content": "FROM node:18-alpine as builder\nWORKDIR /app\nCOPY . .\nRUN npm install --include=dev\nRUN npm run build\n\nFROM node:18-alpine AS runner\nWORKDIR /app\nCOPY --from=builder /app/.next/standalone .\nCOPY --from=builder /app/public ./public\nCOPY --from=builder /app/.next/static ./.next/static\n\nEXPOSE 3000\nCMD [\"node\", \"server.js\"]"
},
{
"path": "LICENSE",
"content": " GNU AFFERO GENERAL PUBLIC LICENSE\n Version 3, 19 November 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n Developers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.\n\n A secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate. Many developers of free software are heartened and\nencouraged by the resulting cooperation. However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.\n\n The GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community. It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server. Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.\n\n An older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals. This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU Affero General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Remote Network Interaction; Use with the GNU General Public License.\n\n Notwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software. This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time. Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as published\n by the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n."
},
{
"path": "README.md",
"content": "# OpenResume\n\nOpenResume is a powerful open-source resume builder and resume parser.\n\nThe goal of OpenResume is to provide everyone with free access to a modern professional resume design and enable anyone to apply for jobs with confidence.\n\nOfficial site: [https://open-resume.com](https://open-resume.com)\n\n## ⚒️ Resume Builder\n\nOpenResume's resume builder allows user to create a modern professional resume easily.\n\n\n\nIt has 5 Core Features:\n|
**Feature**
| **Description** |\n|---|---|\n| **1. Real Time UI Update** | The resume PDF is updated in real time as you enter your resume information, so you can easily see the final output. |\n| **2. Modern Professional Resume Design** | The resume PDF is a modern professional design that adheres to U.S. best practices and is ATS friendly to top ATS platforms such as Greenhouse and Lever. It automatically formats fonts, sizes, margins, bullet points to ensure consistency and avoid human errors. |\n| **3. Privacy Focus** | The app only runs locally on your browser, meaning no sign up is required and no data ever leaves your browser, so it gives you peace of mind on your personal data. (Fun fact: Running only locally means the app still works even if you disconnect the internet.) |\n| **4. Import From Existing Resume PDF** | If you already have an existing resume PDF, you have the option to import it directly, so you can update your resume design to a modern professional design in literally a few seconds. |\n| **5. Successful Track Record** | OpenResume users have landed interviews and offers from top companies, such as Dropbox, Google, Meta to name a few. It has been proven to work and liken by recruiters and hiring managers. |\n\n## 🔍 Resume Parser\n\nOpenResume’s second component is the resume parser. For those who have an existing resume, the resume parser can help test and confirm its ATS readability.\n\n\n\nYou can learn more about the resume parser algorithm in the [\"Resume Parser Algorithm Deep Dive\" section](https://open-resume.com/resume-parser).\n\n## 📚 Tech Stack\n\n|
**Category**
|
**Choice**
| **Descriptions** |\n|---|---|---|\n| **Language** | [TypeScript](https://github.com/microsoft/TypeScript) | TypeScript is JavaScript with static type checking and helps catch many silly bugs at code time. |\n| **UI Library** | [React](https://github.com/facebook/react) | React’s declarative syntax and component-based architecture make it simple to develop reactive reusable components. |\n| **State Management** | [Redux Toolkit](https://github.com/reduxjs/redux-toolkit) | Redux toolkit reduces the boilerplate to set up and update a central redux store, which is used in managing the complex resume state. |\n| **CSS Framework** | [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) | Tailwind speeds up development by providing helpful css utilities and removing the need to context switch between tsx and css files. |\n| **Web Framework** | [NextJS 13](https://github.com/vercel/next.js) | Next.js supports static site generation and helps build efficient React webpages that support SEO. |\n| **PDF Reader** | [PDF.js](https://github.com/mozilla/pdf.js) | PDF.js reads content from PDF files and is used by the resume parser at its first step to read a resume PDF’s content. |\n| **PDF Renderer** | [React-pdf](https://github.com/diegomura/react-pdf) | React-pdf creates PDF files and is used by the resume builder to create a downloadable PDF file. |\n\n## 📁 Project Structure\n\nOpenResume is created with the NextJS web framework and follows its project structure. The source code can be found in `src/app`. There are a total of 4 page routes as shown in the table below. (Code path is relative to `src/app`)\n\n|
**Page Route**
| **Code Path** | **Description** |\n|---|---|---|\n| / | /page.tsx | Home page that contains hero, auto typing resume, steps, testimonials, logo cloud, etc |\n| /resume-import | /resume-import/page.tsx | Resume import page, where you can choose to import data from an existing resume PDF. The main component used is `ResumeDropzone` (`/components/ResumeDropzone.tsx`) |\n| /resume-builder | /resume-builder/page.tsx | Resume builder page to build and download a resume PDF. The main components used are `ResumeForm` (`/components/ResumeForm`) and `Resume` (`/components/Resume`) |\n| /resume-parser | /resume-parser/page.tsx | Resume parser page to test a resume’s AST readability. The main library util used is `parseResumeFromPdf` (`/lib/parse-resume-from-pdf`) |\n\n## 💻 Local Development\n\n### Method 1: npm\n\n1. Download the repo `git clone https://github.com/xitanggg/open-resume.git`\n2. Change the directory `cd open-resume`\n3. Install the dependency `npm install`\n4. Start a development server `npm run dev`\n5. Open your browser and visit [http://localhost:3000](http://localhost:3000) to see OpenResume live\n\n### Method 2: Docker\n\n1. Download the repo `git clone https://github.com/xitanggg/open-resume.git`\n2. Change the directory `cd open-resume`\n3. Build the container `docker build -t open-resume .`\n4. Start the container `docker run -p 3000:3000 open-resume`\n5. Open your browser and visit [http://localhost:3000](http://localhost:3000) to see OpenResume live\n"
},
{
"path": "jest.config.mjs",
"content": "import nextJest from \"next/jest.js\";\n\nconst createJestConfig = nextJest({\n // Provide the path to your Next.js app to load next.config.js and .env files in your test environment\n dir: \"./\",\n});\n\n// Add any custom config to be passed to Jest\n/** @type {import('jest').Config} */\nconst config = {\n // Add more setup options before each test is run\n // setupFilesAfterEnv: ['/jest.setup.js'],\n\n testEnvironment: \"jest-environment-jsdom\",\n};\n\n// createJestConfig is exported this way to ensure that next/jest can load the Next.js config which is async\nexport default createJestConfig(config);\n"
},
{
"path": "next.config.js",
"content": "/** @type {import('next').NextConfig} */\nconst nextConfig = {\n // Nextjs has an issue with pdfjs-dist which optionally uses the canvas package\n // for Node.js compatibility. This causes a \"Module parse failed\" error when\n // building the app. Since pdfjs-dist is only used on client side, we disable\n // the canvas package for webpack\n // https://github.com/mozilla/pdf.js/issues/16214\n output: 'standalone',\n webpack: (config) => {\n // Setting resolve.alias to false tells webpack to ignore a module\n // https://webpack.js.org/configuration/resolve/#resolvealias\n config.resolve.alias.canvas = false;\n config.resolve.alias.encoding = false;\n return config;\n },\n};\n\nmodule.exports = nextConfig;\n"
},
{
"path": "package.json",
"content": "{\n \"name\": \"open-resume\",\n \"version\": \"0.1.0\",\n \"private\": true,\n \"scripts\": {\n \"dev\": \"next dev\",\n \"build\": \"next build\",\n \"start\": \"next start\",\n \"lint\": \"next lint\",\n \"test\": \"jest --watch\",\n \"test:ci\": \"jest --ci\"\n },\n \"dependencies\": {\n \"@heroicons/react\": \"^2.0.18\",\n \"@react-pdf/renderer\": \"^3.1.10\",\n \"@reduxjs/toolkit\": \"^1.9.5\",\n \"@types/node\": \"20.2.5\",\n \"@types/react\": \"18.2.7\",\n \"@types/react-dom\": \"18.2.4\",\n \"@vercel/analytics\": \"^1.0.1\",\n \"autoprefixer\": \"10.4.14\",\n \"eslint\": \"8.41.0\",\n \"eslint-config-next\": \"13.4.4\",\n \"next\": \"13.4.4\",\n \"pdfjs\": \"^2.5.0\",\n \"pdfjs-dist\": \"^3.7.107\",\n \"postcss\": \"8.4.24\",\n \"react\": \"18.2.0\",\n \"react-contenteditable\": \"^3.3.7\",\n \"react-dom\": \"18.2.0\",\n \"react-frame-component\": \"^5.2.6\",\n \"react-redux\": \"^8.0.7\",\n \"tailwind-scrollbar\": \"^3.0.4\",\n \"tailwindcss\": \"3.3.2\",\n \"typescript\": \"5.0.4\"\n },\n \"devDependencies\": {\n \"@tailwindcss/aspect-ratio\": \"^0.4.2\",\n \"@testing-library/jest-dom\": \"^5.16.5\",\n \"@testing-library/react\": \"^14.0.0\",\n \"jest\": \"^29.5.0\",\n \"jest-environment-jsdom\": \"^29.5.0\",\n \"prettier-plugin-tailwindcss\": \"^0.2.1\"\n }\n}\n"
},
{
"path": "postcss.config.js",
"content": "module.exports = {\n plugins: {\n tailwindcss: {},\n autoprefixer: {},\n },\n}\n"
},
{
"path": "prettier.config.js",
"content": "module.exports = {\n // Repo: https://github.com/tailwindlabs/prettier-plugin-tailwindcss\n plugins: [require(\"prettier-plugin-tailwindcss\")],\n};\n"
},
{
"path": "prettierignore",
"content": "public/fonts/*.css"
},
{
"path": "public/fonts/OFL.txt",
"content": "Copyright (c), Christian Robertson (https://fonts.google.com/specimen/Roboto/about?query=Roboto),\nwith Reserved Font Name Roboto.\n\nCopyright (c), Łukasz Dziedzic (https://fonts.google.com/specimen/Lato?query=lato),\nwith Reserved Font Name Lato.\n\nCopyright (c), Julieta Ulanovsky, Sol Matas, Juan Pablo del Peral, Jacques Le Bailly (https://fonts.google.com/specimen/Montserrat?query=Montserrat),\nwith Reserved Font Name Montserrat.\n\nCopyright (c), Steve Matteson (https://fonts.google.com/specimen/Open+Sans?query=Open+Sans),\nwith Reserved Font Name Open Sans.\n\nCopyright (c), Matt McInerney, Pablo Impallari, Rodrigo Fuenzalida (https://fonts.google.com/specimen/Raleway?query=Raleway),\nwith Reserved Font Name Raleway.\n\nCopyright (c), Andrés Torresi, Carolina Giovanolli (https://fonts.google.com/specimen/Caladea?query=Caladea),\nwith Reserved Font Name Caladea.\n\nCopyright (c), Cyreal (https://fonts.google.com/specimen/Lora?query=Lora),\nwith Reserved Font Name Lora.\n\nCopyright (c), Christian Robertson (https://fonts.google.com/specimen/Roboto+Slab/about?query=Roboto+Slab),\nwith Reserved Font Name Roboto Slab.\n\nCopyright (c), Claus Eggers Sørensen (https://fonts.google.com/specimen/Playfair+Display?query=Playfair+Display),\nwith Reserved Font Name Playfair Display.\n\nCopyright (c), Sorkin Type (https://fonts.google.com/specimen/Merriweather/about?query=Merriweather),\nwith Reserved Font Name Merriweather.\n\nCopyright (c), (https://fonts.google.com/noto/specimen/Noto+Sans+SC?query=Noto+Sans+SC¬o.query=Noto+Sans+SC),\nwith Reserved Font Name Noto Sans Simplified Chinese.\n\nThis Font Software is licensed under the SIL Open Font License, Version 1.1.\nThis license is copied below, and is also available with a FAQ at:\nhttp://scripts.sil.org/OFL\n\n\n-----------------------------------------------------------\nSIL OPEN FONT LICENSE Version 1.1 - 26 February 2007\n-----------------------------------------------------------\n\nPREAMBLE\nThe goals of the Open Font License (OFL) are to stimulate worldwide\ndevelopment of collaborative font projects, to support the font creation\nefforts of academic and linguistic communities, and to provide a free and\nopen framework in which fonts may be shared and improved in partnership\nwith others.\n\nThe OFL allows the licensed fonts to be used, studied, modified and\nredistributed freely as long as they are not sold by themselves. The\nfonts, including any derivative works, can be bundled, embedded, \nredistributed and/or sold with any software provided that any reserved\nnames are not used by derivative works. The fonts and derivatives,\nhowever, cannot be released under any other type of license. The\nrequirement for fonts to remain under this license does not apply\nto any document created using the fonts or their derivatives.\n\nDEFINITIONS\n\"Font Software\" refers to the set of files released by the Copyright\nHolder(s) under this license and clearly marked as such. This may\ninclude source files, build scripts and documentation.\n\n\"Reserved Font Name\" refers to any names specified as such after the\ncopyright statement(s).\n\n\"Original Version\" refers to the collection of Font Software components as\ndistributed by the Copyright Holder(s).\n\n\"Modified Version\" refers to any derivative made by adding to, deleting,\nor substituting -- in part or in whole -- any of the components of the\nOriginal Version, by changing formats or by porting the Font Software to a\nnew environment.\n\n\"Author\" refers to any designer, engineer, programmer, technical\nwriter or other person who contributed to the Font Software.\n\nPERMISSION & CONDITIONS\nPermission is hereby granted, free of charge, to any person obtaining\na copy of the Font Software, to use, study, copy, merge, embed, modify,\nredistribute, and sell modified and unmodified copies of the Font\nSoftware, subject to the following conditions:\n\n1) Neither the Font Software nor any of its individual components,\nin Original or Modified Versions, may be sold by itself.\n\n2) Original or Modified Versions of the Font Software may be bundled,\nredistributed and/or sold with any software, provided that each copy\ncontains the above copyright notice and this license. These can be\nincluded either as stand-alone text files, human-readable headers or\nin the appropriate machine-readable metadata fields within text or\nbinary files as long as those fields can be easily viewed by the user.\n\n3) No Modified Version of the Font Software may use the Reserved Font\nName(s) unless explicit written permission is granted by the corresponding\nCopyright Holder. This restriction only applies to the primary font name as\npresented to the users.\n\n4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font\nSoftware shall not be used to promote, endorse or advertise any\nModified Version, except to acknowledge the contribution(s) of the\nCopyright Holder(s) and the Author(s) or with their explicit written\npermission.\n\n5) The Font Software, modified or unmodified, in part or in whole,\nmust be distributed entirely under this license, and must not be\ndistributed under any other license. The requirement for fonts to\nremain under this license does not apply to any document created\nusing the Font Software.\n\nTERMINATION\nThis license becomes null and void if any of the above conditions are\nnot met.\n\nDISCLAIMER\nTHE FONT SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\nOF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE\nCOPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nINCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL\nDAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM\nOTHER DEALINGS IN THE FONT SOFTWARE.\n"
},
{
"path": "public/fonts/fonts-zh.css",
"content": "@font-face {font-family: \"NotoSansSC\"; src: url(\"/fonts/NotoSansSC-Regular.ttf\");}\n@font-face {font-family: \"NotoSansSC\"; src: url(\"/fonts/NotoSansSC-Bold.ttf\"); font-weight: bold;}"
},
{
"path": "public/fonts/fonts.css",
"content": "/* Adding a new English font family needs to keep \"public\\fonts\\fonts.ts\" in sync */\n/* Sans Serif Fonts */\n@font-face {font-family: \"Roboto\"; src: url(\"/fonts/Roboto-Regular.ttf\");}\n@font-face {font-family: \"Roboto\"; src: url(\"/fonts/Roboto-Bold.ttf\"); font-weight: bold;}\n@font-face {font-family: \"Lato\"; src: url(\"/fonts/Lato-Regular.ttf\");}\n@font-face {font-family: \"Lato\"; src: url(\"/fonts/Lato-Bold.ttf\"); font-weight: bold;}\n@font-face {font-family: \"Montserrat\"; src: url(\"/fonts/Montserrat-Regular.ttf\");}\n@font-face {font-family: \"Montserrat\"; src: url(\"/fonts/Montserrat-Bold.ttf\"); font-weight: bold;}\n@font-face {font-family: \"OpenSans\"; src: url(\"/fonts/OpenSans-Regular.ttf\");}\n@font-face {font-family: \"OpenSans\"; src: url(\"/fonts/OpenSans-Bold.ttf\"); font-weight: bold;}\n@font-face {font-family: \"Raleway\"; src: url(\"/fonts/Raleway-Regular.ttf\");}\n@font-face {font-family: \"Raleway\"; src: url(\"/fonts/Raleway-Bold.ttf\"); font-weight: bold;}\n\n/* Serif Fonts */\n@font-face {font-family: \"Caladea\"; src: url(\"/fonts/Caladea-Regular.ttf\");}\n@font-face {font-family: \"Caladea\"; src: url(\"/fonts/Caladea-Bold.ttf\"); font-weight: bold;}\n@font-face {font-family: \"Lora\"; src: url(\"/fonts/Lora-Regular.ttf\");}\n@font-face {font-family: \"Lora\"; src: url(\"/fonts/Lora-Bold.ttf\"); font-weight: bold;}\n@font-face {font-family: \"RobotoSlab\"; src: url(\"/fonts/RobotoSlab-Regular.ttf\");}\n@font-face {font-family: \"RobotoSlab\"; src: url(\"/fonts/RobotoSlab-Bold.ttf\"); font-weight: bold;}\n@font-face {font-family: \"PlayfairDisplay\"; src: url(\"/fonts/PlayfairDisplay-Regular.ttf\");}\n@font-face {font-family: \"PlayfairDisplay\"; src: url(\"/fonts/PlayfairDisplay-Bold.ttf\"); font-weight: bold;}\n@font-face {font-family: \"Merriweather\"; src: url(\"/fonts/Merriweather-Regular.ttf\");}\n@font-face {font-family: \"Merriweather\"; src: url(\"/fonts/Merriweather-Bold.ttf\"); font-weight: bold;}\n"
},
{
"path": "src/app/components/Button.tsx",
"content": "import { cx } from \"lib/cx\";\nimport { Tooltip } from \"components/Tooltip\";\n\ntype ReactButtonProps = React.ComponentProps<\"button\">;\ntype ReactAnchorProps = React.ComponentProps<\"a\">;\ntype ButtonProps = ReactButtonProps | ReactAnchorProps;\n\nconst isAnchor = (props: ButtonProps): props is ReactAnchorProps => {\n return \"href\" in props;\n};\n\nexport const Button = (props: ButtonProps) => {\n if (isAnchor(props)) {\n return ;\n } else {\n return ;\n }\n};\n\nexport const PrimaryButton = ({ className, ...props }: ButtonProps) => (\n \n);\n\ntype IconButtonProps = ButtonProps & {\n size?: \"small\" | \"medium\";\n tooltipText: string;\n};\n\nexport const IconButton = ({\n className,\n size = \"medium\",\n tooltipText,\n ...props\n}: IconButtonProps) => (\n \n \n \n);\n"
},
{
"path": "src/app/components/ExpanderWithHeightTransition.tsx",
"content": "/**\n * ExpanderWithHeightTransition is a div wrapper with built-in transition animation based on height.\n * If expanded is true, it slowly expands its content and vice versa.\n *\n * Note: There is no easy way to animate height transition in CSS: https://github.com/w3c/csswg-drafts/issues/626.\n * This is a clever solution based on css grid and is borrowed from https://css-tricks.com/css-grid-can-do-auto-height-transitions/\n *\n */\nexport const ExpanderWithHeightTransition = ({\n expanded,\n children,\n}: {\n expanded: boolean;\n children: React.ReactNode;\n}) => {\n return (\n \n
{children}
\n \n );\n};\n"
},
{
"path": "src/app/components/FlexboxSpacer.tsx",
"content": "/**\n * FlexboxSpacer can be used to create empty space in flex.\n * It is a div that grows to fill the available space specified by maxWidth.\n * You can also set a minimum width with minWidth.\n */\nexport const FlexboxSpacer = ({\n maxWidth,\n minWidth = 0,\n className = \"\",\n}: {\n maxWidth: number;\n minWidth?: number;\n className?: string;\n}) => (\n \n);\n"
},
{
"path": "src/app/components/Resume/ResumeControlBar.tsx",
"content": "\"use client\";\nimport { useEffect } from \"react\";\nimport { useSetDefaultScale } from \"components/Resume/hooks\";\nimport {\n MagnifyingGlassIcon,\n ArrowDownTrayIcon,\n} from \"@heroicons/react/24/outline\";\nimport { usePDF } from \"@react-pdf/renderer\";\nimport dynamic from \"next/dynamic\";\n\nconst ResumeControlBar = ({\n scale,\n setScale,\n documentSize,\n document,\n fileName,\n}: {\n scale: number;\n setScale: (scale: number) => void;\n documentSize: string;\n document: JSX.Element;\n fileName: string;\n}) => {\n const { scaleOnResize, setScaleOnResize } = useSetDefaultScale({\n setScale,\n documentSize,\n });\n\n const [instance, update] = usePDF({ document });\n\n // Hook to update pdf when document changes\n useEffect(() => {\n update();\n }, [update, document]);\n\n return (\n
\n ))}\n \n \n );\n};\n"
},
{
"path": "src/app/components/documentation/index.tsx",
"content": "import { Heading } from \"components/documentation/Heading\";\nimport { Paragraph } from \"components/documentation/Paragraph\";\nimport { Link } from \"components/documentation/Link\";\nimport { Badge } from \"components/documentation/Badge\";\nimport { Table } from \"components/documentation/Table\";\n\nexport { Heading, Paragraph, Link, Badge, Table };\n"
},
{
"path": "src/app/components/fonts/FontsZh.tsx",
"content": "import \"public/fonts/fonts-zh.css\";\n\n/**\n * Empty component. Main purpose is to load fonts-zh.css\n */\nconst FontsZh = () => <>;\nexport default FontsZh;\n"
},
{
"path": "src/app/components/fonts/NonEnglishFontsCSSLoader.tsx",
"content": "import { useState, useEffect } from \"react\";\nimport dynamic from \"next/dynamic\";\nimport { getAllFontFamiliesToLoad } from \"components/fonts/lib\";\n\nconst FontsZhCSR = dynamic(() => import(\"components/fonts/FontsZh\"), {\n ssr: false,\n});\n\n/**\n * Empty component to lazy load non-english fonts CSS conditionally\n *\n * Reference: https://prawira.medium.com/react-conditional-import-conditional-css-import-110cc58e0da6\n */\nexport const NonEnglishFontsCSSLazyLoader = () => {\n const [shouldLoadFontsZh, setShouldLoadFontsZh] = useState(false);\n\n useEffect(() => {\n if (getAllFontFamiliesToLoad().includes(\"NotoSansSC\")) {\n setShouldLoadFontsZh(true);\n }\n }, []);\n\n return <>{shouldLoadFontsZh && };\n};\n"
},
{
"path": "src/app/components/fonts/constants.ts",
"content": "/**\n * Adding a new font family involves 4 steps:\n * Step 1. Add it to one of the below FONT_FAMILIES variable array:\n * English fonts -> SANS_SERIF_ENGLISH_FONT_FAMILIES or SERIF_ENGLISH_FONT_FAMILIES\n * Non-English fonts -> NON_ENGLISH_FONT_FAMILIES\n * Once the font is added, it would take care of\n * a. Registering font family for React PDF at \"components/fonts/hooks.tsx\"\n * b. Loading font family for React PDF iframe at \"components/Resume/ResumeIFrame.tsx\"\n * c. Adding font family selection to Resume Settings at \"components/ResumeForm/ThemeForm/Selection.tsx\"\n * Step 2. To load css correctly for the Resume Form:\n * English fonts -> add it to the \"public\\fonts\\fonts.css\" file\n * Non-English fonts -> create/update \"public\\fonts\\fonts-.css\" and update \"components/fonts/NonEnglishFontsCSSLazyLoader.tsx\"\n * Step 3. Update FONT_FAMILY_TO_STANDARD_SIZE_IN_PT and FONT_FAMILY_TO_DISPLAY_NAME accordingly\n * Step 4. Update \"public/fonts/OFL.txt\" to include the new font family and credit the font creator\n *\n * IMPORTANT NOTE:\n * One major problem with adding a new font family is that most font family doesn't work with\n * React PDF out of box. The texts would appear fine in the PDF, but copying and pasting them\n * would result in different texts. See issues: https://github.com/diegomura/react-pdf/issues/915\n * and https://github.com/diegomura/react-pdf/issues/629\n *\n * A solution to this problem is to import and re-export the font with a font editor, e.g. fontforge or birdfont.\n *\n * If using fontforge, the following command can be used to export the font:\n * ./fontforge -lang=ff -c 'Open($1); Generate($2); Close();' old_font.ttf new_font.ttf\n * Note that fontforge doesn't work on non-english fonts: https://github.com/fontforge/fontforge/issues/1534\n * Also, some fonts might still not work after re-export.\n */\n\nconst SANS_SERIF_ENGLISH_FONT_FAMILIES = [\n \"Roboto\",\n \"Lato\",\n \"Montserrat\",\n \"OpenSans\",\n \"Raleway\",\n] as const;\n\nconst SERIF_ENGLISH_FONT_FAMILIES = [\n \"Caladea\",\n \"Lora\",\n \"RobotoSlab\",\n \"PlayfairDisplay\",\n \"Merriweather\",\n] as const;\n\nexport const ENGLISH_FONT_FAMILIES = [\n ...SANS_SERIF_ENGLISH_FONT_FAMILIES,\n ...SERIF_ENGLISH_FONT_FAMILIES,\n];\ntype EnglishFontFamily = (typeof ENGLISH_FONT_FAMILIES)[number];\n\nexport const NON_ENGLISH_FONT_FAMILIES = [\"NotoSansSC\"] as const;\ntype NonEnglishFontFamily = (typeof NON_ENGLISH_FONT_FAMILIES)[number];\n\nexport const NON_ENGLISH_FONT_FAMILY_TO_LANGUAGE: Record<\n NonEnglishFontFamily,\n string[]\n> = {\n NotoSansSC: [\"zh\", \"zh-CN\", \"zh-TW\"],\n};\n\nexport type FontFamily = EnglishFontFamily | NonEnglishFontFamily;\nexport const FONT_FAMILY_TO_STANDARD_SIZE_IN_PT: Record = {\n // Sans Serif Fonts\n Roboto: 11,\n Lato: 11,\n Montserrat: 10,\n OpenSans: 10,\n Raleway: 10,\n // Serif Fonts\n Caladea: 11,\n Lora: 11,\n RobotoSlab: 10,\n PlayfairDisplay: 10,\n Merriweather: 10,\n // Non-English Fonts\n NotoSansSC: 11,\n};\n\nexport const FONT_FAMILY_TO_DISPLAY_NAME: Record = {\n // Sans Serif Fonts\n Roboto: \"Roboto\",\n Lato: \"Lato\",\n Montserrat: \"Montserrat\",\n OpenSans: \"Open Sans\",\n Raleway: \"Raleway\",\n // Serif Fonts\n Caladea: \"Caladea\",\n Lora: \"Lora\",\n RobotoSlab: \"Roboto Slab\",\n PlayfairDisplay: \"Playfair Display\",\n Merriweather: \"Merriweather\",\n // Non-English Fonts\n NotoSansSC: \"思源黑体(简体)\",\n};\n"
},
{
"path": "src/app/components/fonts/hooks.tsx",
"content": "import { useEffect } from \"react\";\nimport { Font } from \"@react-pdf/renderer\";\nimport { ENGLISH_FONT_FAMILIES } from \"components/fonts/constants\";\nimport { getAllFontFamiliesToLoad } from \"components/fonts/lib\";\n\n/**\n * Register all fonts to React PDF so it can render fonts correctly in PDF\n */\nexport const useRegisterReactPDFFont = () => {\n useEffect(() => {\n const allFontFamilies = getAllFontFamiliesToLoad();\n allFontFamilies.forEach((fontFamily) => {\n Font.register({\n family: fontFamily,\n fonts: [\n {\n src: `fonts/${fontFamily}-Regular.ttf`,\n },\n {\n src: `fonts/${fontFamily}-Bold.ttf`,\n fontWeight: \"bold\",\n },\n ],\n });\n });\n }, []);\n};\n\nexport const useRegisterReactPDFHyphenationCallback = (fontFamily: string) => {\n useEffect(() => {\n if (ENGLISH_FONT_FAMILIES.includes(fontFamily as any)) {\n // Disable hyphenation for English Font Family so the word wraps each line\n // https://github.com/diegomura/react-pdf/issues/311#issuecomment-548301604\n Font.registerHyphenationCallback((word) => [word]);\n } else {\n // React PDF doesn't understand how to wrap non-english word on line break\n // A workaround is to add an empty character after each word\n // Reference https://github.com/diegomura/react-pdf/issues/1568\n Font.registerHyphenationCallback((word) =>\n word\n .split(\"\")\n .map((char) => [char, \"\"])\n .flat()\n );\n }\n }, [fontFamily]);\n};\n"
},
{
"path": "src/app/components/fonts/lib.ts",
"content": "\"use client\";\nimport {\n ENGLISH_FONT_FAMILIES,\n NON_ENGLISH_FONT_FAMILIES,\n NON_ENGLISH_FONT_FAMILY_TO_LANGUAGE,\n} from \"components/fonts/constants\";\n\n/**\n * getPreferredNonEnglishFontFamilies returns non-english font families that are included in\n * user's preferred languages. This is to avoid loading fonts/languages that users won't use.\n */\nconst getPreferredNonEnglishFontFamilies = () => {\n return NON_ENGLISH_FONT_FAMILIES.filter((fontFamily) => {\n const fontLanguages = NON_ENGLISH_FONT_FAMILY_TO_LANGUAGE[fontFamily];\n const userPreferredLanguages = navigator.languages ?? [navigator.language];\n return userPreferredLanguages.some((preferredLanguage) =>\n fontLanguages.includes(preferredLanguage)\n );\n });\n};\n\nexport const getAllFontFamiliesToLoad = () => {\n return [...ENGLISH_FONT_FAMILIES, ...getPreferredNonEnglishFontFamilies()];\n};\n"
},
{
"path": "src/app/globals-css.ts",
"content": "export const CSS_VARIABLES = {\n \"--top-nav-bar-height\": \"3.5rem\",\n \"--resume-control-bar-height\": \"3rem\",\n \"--resume-padding\": \"1.5rem\",\n} as const;\n"
},
{
"path": "src/app/globals.css",
"content": "@import url(\"/fonts/fonts.css\");\n@tailwind base;\n@tailwind components;\n@tailwind utilities;\n\n@layer components {\n .btn-primary {\n @apply bg-primary outline-theme-purple inline-block rounded-full px-6 py-2 font-semibold shadow-sm;\n }\n .text-primary {\n @apply bg-gradient-to-r from-[color:var(--theme-purple)] to-[color:var(--theme-blue)] bg-clip-text text-transparent !important;\n }\n .bg-primary {\n @apply bg-gradient-to-r from-[color:var(--theme-purple)] to-[color:var(--theme-blue)] text-white;\n }\n .outline-theme-purple {\n @apply hover:opacity-80 hover:outline-[color:var(--theme-purple)] focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[color:var(--theme-purple)];\n }\n .outline-theme-blue {\n @apply hover:opacity-80 hover:outline-[color:var(--theme-blue)] focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-[color:var(--theme-blue)];\n }\n .within-outline-theme-purple {\n @apply focus-within:outline focus-within:outline-2 focus-within:outline-offset-2 focus-within:outline-[color:var(--theme-purple)] hover:opacity-80 hover:outline-[color:var(--theme-purple)];\n }\n}\n\n:root {\n --theme-purple: #5d52d9;\n --theme-blue: #4fc5eb;\n /* Keep the below variable names in sync with CSS_VARIABLES in globals-css.ts */\n --top-nav-bar-height: 3.5rem;\n --resume-control-bar-height: 3rem;\n --resume-padding: 1.5rem;\n}\n"
},
{
"path": "src/app/home/AutoTypingResume.tsx",
"content": "\"use client\";\nimport { useEffect, useState, useRef } from \"react\";\nimport { ResumePDF } from \"components/Resume/ResumePDF\";\nimport { initialResumeState } from \"lib/redux/resumeSlice\";\nimport { initialSettings } from \"lib/redux/settingsSlice\";\nimport { ResumeIframeCSR } from \"components/Resume/ResumeIFrame\";\nimport { START_HOME_RESUME, END_HOME_RESUME } from \"home/constants\";\nimport { makeObjectCharIterator } from \"lib/make-object-char-iterator\";\nimport { useTailwindBreakpoints } from \"lib/hooks/useTailwindBreakpoints\";\nimport { deepClone } from \"lib/deep-clone\";\n\n// countObjectChar(END_HOME_RESUME) -> ~1800 chars\nconst INTERVAL_MS = 50; // 20 Intervals Per Second\nconst CHARS_PER_INTERVAL = 10;\n// Auto Typing Time:\n// 10 CHARS_PER_INTERVAL -> ~1800 / (20*10) = 9s (let's go with 9s so it feels fast)\n// 9 CHARS_PER_INTERVAL -> ~1800 / (20*9) = 10s\n// 8 CHARS_PER_INTERVAL -> ~1800 / (20*8) = 11s\n\nconst RESET_INTERVAL_MS = 60 * 1000; // 60s\n\nexport const AutoTypingResume = () => {\n const [resume, setResume] = useState(deepClone(initialResumeState));\n const resumeCharIterator = useRef(\n makeObjectCharIterator(START_HOME_RESUME, END_HOME_RESUME)\n );\n const hasSetEndResume = useRef(false);\n const { isLg } = useTailwindBreakpoints();\n\n useEffect(() => {\n const intervalId = setInterval(() => {\n let next = resumeCharIterator.current.next();\n for (let i = 0; i < CHARS_PER_INTERVAL - 1; i++) {\n next = resumeCharIterator.current.next();\n }\n if (!next.done) {\n setResume(next.value);\n } else {\n // Sometimes the iterator doesn't end on the last char,\n // so we manually set its end state here\n if (!hasSetEndResume.current) {\n setResume(END_HOME_RESUME);\n hasSetEndResume.current = true;\n }\n }\n }, INTERVAL_MS);\n return () => clearInterval(intervalId);\n }, []);\n\n useEffect(() => {\n const intervalId = setInterval(() => {\n resumeCharIterator.current = makeObjectCharIterator(\n START_HOME_RESUME,\n END_HOME_RESUME\n );\n hasSetEndResume.current = false;\n }, RESET_INTERVAL_MS);\n return () => clearInterval(intervalId);\n }, []);\n\n return (\n <>\n \n \n \n \n );\n};\n"
},
{
"path": "src/app/home/Features.tsx",
"content": "import Image from \"next/image\";\nimport featureFreeSrc from \"public/assets/feature-free.svg\";\nimport featureUSSrc from \"public/assets/feature-us.svg\";\nimport featurePrivacySrc from \"public/assets/feature-privacy.svg\";\nimport featureOpenSourceSrc from \"public/assets/feature-open-source.svg\";\nimport { Link } from \"components/documentation\";\n\nconst FEATURES = [\n {\n src: featureFreeSrc,\n title: \"Free Forever\",\n text: \"OpenResume is created with the belief that everyone should have free and easy access to a modern professional resume design\",\n },\n {\n src: featureUSSrc,\n title: \"U.S. Best Practices\",\n text: \"OpenResume has built-in best practices for the U.S. job market and works well with top ATS platforms such as Greenhouse and Lever\",\n },\n {\n src: featurePrivacySrc,\n title: \"Privacy Focus\",\n text: \"OpenResume stores data locally in your browser so only you have access to your data and with complete control\",\n },\n {\n src: featureOpenSourceSrc,\n title: \"Open-Source\",\n text: (\n <>\n OpenResume is an open-source project, and its source code can be viewed\n by anyone on its{\" \"}\n \n GitHub repository\n \n \n ),\n },\n];\n\nexport const Features = () => {\n return (\n \n
\n
\n {FEATURES.map(({ src, title, text }) => (\n
\n
\n
\n \n {title}\n
\n
{text}
\n
\n
\n ))}\n
\n
\n \n );\n};\n"
},
{
"path": "src/app/home/Hero.tsx",
"content": "import Link from \"next/link\";\nimport { FlexboxSpacer } from \"components/FlexboxSpacer\";\nimport { AutoTypingResume } from \"home/AutoTypingResume\";\n\nexport const Hero = () => {\n return (\n \n \n
\n
\n Create a professional\n \n resume easily\n
\n
\n With this free, open-source, and powerful resume builder\n
\n \n Create Resume →\n \n
No sign up required
\n
\n Already have a resume? Test its ATS readability with the{\" \"}\n \n resume parser\n \n
\n
\n \n
\n \n
\n \n );\n};\n"
},
{
"path": "src/app/home/LogoCloud.tsx",
"content": "import logoCornellSrc from \"public/assets/logo-cornell.svg\";\nimport logoColumbiaSrc from \"public/assets/logo-columbia.svg\";\nimport logoNortheasternSrc from \"public/assets/logo-northeastern.svg\";\nimport logoDropboxSrc from \"public/assets/logo-dropbox.svg\";\nimport logoGoogleSrc from \"public/assets/logo-google.svg\";\nimport logoAmazonSrc from \"public/assets/logo-amazon.svg\";\nimport Image from \"next/image\";\n\nconst LOGOS = [\n { src: logoCornellSrc, alt: \"Cornell University logo\" },\n { src: logoColumbiaSrc, alt: \"Columbia University logo\" },\n { src: logoNortheasternSrc, alt: \"Northeastern University logo\" },\n { src: logoDropboxSrc, alt: \"Dropbox logo\" },\n { src: logoGoogleSrc, alt: \"Google logo\" },\n { src: logoAmazonSrc, alt: \"Amazon logo\" },\n];\n\n// LogoCloud is disabled per issue: https://github.com/xitanggg/open-resume/issues/7\nexport const LogoCloud = () => (\n \n
\n Trusted by students and employees from top universities and companies\n worldwide\n
\n
\n {LOGOS.map(({ src, alt }, idx) => (\n \n ))}\n
\n \n);\n"
},
{
"path": "src/app/home/QuestionsAndAnswers.tsx",
"content": "import { Link } from \"components/documentation\";\n\nconst QAS = [\n {\n question:\n \"Q1. What is a resume builder? Why resume builder is better than resume template doc?\",\n answer: (\n <>\n
\n There are two ways to create a resume today. One option is to use a\n resume template, such as an office/google doc, and customize it\n according to your needs. The other option is to use a resume builder,\n an online tool that allows you to input your information and\n automatically generates a resume for you.\n
\n
\n Using a resume template requires manual formatting work, like copying\n and pasting text sections and adjusting spacing, which can be\n time-consuming and error-prone. It is easy to run into formatting\n issues, such as using different bullet points or font styles after\n copying and pasting. On the other hand, a resume builder like\n OpenResume saves time and prevents formatting mistakes by\n automatically formatting the resume. It also offers the convenience of\n easily changing font types or sizes with a simple click. In summary, a\n resume builder is easier to use compared to a resume template.\n
\n \n ),\n },\n {\n question:\n \"Q2. What uniquely sets OpenResume apart from other resume builders and templates?\",\n answer: (\n <>\n
\n Other than OpenResume, there are some great free resume builders out\n there, e.g. Reactive Resume,{\" \"}\n FlowCV. However, OpenResume\n stands out with 2 distinctive features:\n
{\" \"}\n
\n \n 1. OpenResume is designed specifically for the U.S. job market and\n best practices.\n \n \n Unlike other resume builders that target a global audience and offer\n many customization options, OpenResume intentionally only offers\n options that are aligned with U.S. best practices. For example, it\n excludes the option to add a profile picture to avoid bias and\n discrimination. It offers only the core sections, e.g. profile, work\n experience, education, and skills, while omitting unnecessary sections\n like references. Additionally, OpenResume only offers a top down\n single column resume design as opposed to two column design, because\n single column design works best for AST. {\" \"}\n
\n
\n \n 2. OpenResume is super privacy focus.\n {\" \"}\n \n While other resume builders may require email sign up and store user\n data in their databases, OpenResume believes that resume data should\n remain private and accessible only on user’s local machine. Therefore,\n OpenResume doesn’t require sign up to use the app, and all inputted\n data is stored in user’s browser that only user has access to.\n
\n \n ),\n },\n {\n question: \"Q3. Who created OpenResume and why?\",\n answer: (\n
\n OpenResume was created by{\" \"}\n Xitang Zhao and designed\n by Zhigang Wen as\n a weekend project. As immigrants to the US, we had made many mistakes\n when creating our first resumes and applying for internships and jobs.\n It took us a long while to learn some of the best practices. While\n mentoring first generation students and reviewing their resumes, we\n noticed students were making the same mistakes that we had made before.\n This led us to think about how we can be of help with the knowledge and\n skills we have gained. We started chatting and working over the weekends\n that led to OpenResume, where we integrated best practices and our\n knowledge into this resume builder. Our hope is that OpenResume can help\n anyone to easily create a modern professional resume that follows best\n practices and enable anyone to apply for jobs with confidence.\n
\n ),\n },\n {\n question: \"Q4. How can I support OpenResume?\",\n answer: (\n <>\n
\n The best way to support OpenResume is to share your thoughts and\n feedback with us to help further improve it. You can send us an email\n at{\" \"}\n hello@open-resume.com{\" \"}\n or{\" \"}\n \n open an issue\n {\" \"}\n at our Github repository. Whether you like it or not, we would love to\n hear from you.\n
\n
\n Another great way to support OpenResume is by spreading the words.\n Share it with your friends, on social media platforms, or with your\n school’s career center. Our goal is to reach more people who struggle\n with creating their resume, and your word-of-mouth support would be\n greatly appreciated. If you use Github, you can also show your support\n by{\" \"}\n \n giving the project a star\n {\" \"}\n to help increase its popularity and reach.\n
\n \n );\n};\n"
},
{
"path": "src/app/home/Testimonials.tsx",
"content": "\"use client\";\nimport heartSrc from \"public/assets/heart.svg\";\nimport testimonialSpiegelSrc from \"public/assets/testimonial-spiegel.jpg\";\nimport testimonialSantiSrc from \"public/assets/testimonial-santi.jpg\";\nimport testimonialVivianSrc from \"public/assets/testimonial-vivian.jpg\";\nimport React, { useEffect, useRef, useState } from \"react\";\nimport Image from \"next/image\";\nimport { useTailwindBreakpoints } from \"lib/hooks/useTailwindBreakpoints\";\n\nconst TESTIMONIALS = [\n {\n src: testimonialSpiegelSrc,\n quote:\n \"Students often make silly mistakes on their resume by using inconsistent bullet points or font sizes. OpenResume’s auto format feature is a great help to ensure consistent format.\",\n name: \"Ms. Spiegel\",\n title: \"Educator\",\n },\n {\n src: testimonialSantiSrc,\n quote:\n \"I used OpenResume during my last job search and was invited to interview at top tech companies such as Google and Amazon thanks to its slick yet professional resume design.\",\n name: \"Santi\",\n title: \"Software Engineer\",\n },\n {\n src: testimonialVivianSrc,\n quote:\n \"Creating a professional resume on OpenResume is so smooth and easy! It saves me so much time and headache to not deal with google doc template.\",\n name: \"Vivian\",\n title: \"College Student\",\n },\n];\n\nconst LG_TESTIMONIALS_CLASSNAMES = [\n \"z-10\",\n \"translate-x-44 translate-y-24 opacity-40\",\n \"translate-x-32 -translate-y-28 opacity-40\",\n];\nconst SM_TESTIMONIALS_CLASSNAMES = [\"z-10\", \"opacity-0\", \"opacity-0\"];\nconst ROTATION_INTERVAL_MS = 8 * 1000; // 8s\n\nexport const Testimonials = ({ children }: { children?: React.ReactNode }) => {\n const [testimonialsClassNames, setTestimonialsClassNames] = useState(\n LG_TESTIMONIALS_CLASSNAMES\n );\n const isHoveredOnTestimonial = useRef(false);\n useEffect(() => {\n const intervalId = setInterval(() => {\n if (!isHoveredOnTestimonial.current) {\n setTestimonialsClassNames((preClassNames) => {\n return [preClassNames[1], preClassNames[2], preClassNames[0]];\n });\n }\n }, ROTATION_INTERVAL_MS);\n return () => clearInterval(intervalId);\n }, []);\n\n const { isLg } = useTailwindBreakpoints();\n useEffect(() => {\n setTestimonialsClassNames(\n isLg ? LG_TESTIMONIALS_CLASSNAMES : SM_TESTIMONIALS_CLASSNAMES\n );\n }, [isLg]);\n\n return (\n \n
\n \n );\n};\n"
},
{
"path": "src/app/resume-parser/ResumeParserAlgorithmArticle.tsx",
"content": "import { isBold } from \"lib/parse-resume-from-pdf/extract-resume-from-sections/lib/common-features\";\nimport {\n Badge,\n Heading,\n Link,\n Paragraph,\n Table,\n} from \"components/documentation\";\nimport type {\n Line,\n Lines,\n ResumeSectionToLines,\n TextItem,\n TextItems,\n TextScores,\n} from \"lib/parse-resume-from-pdf/types\";\nimport { extractProfile } from \"lib/parse-resume-from-pdf/extract-resume-from-sections/extract-profile\";\n\nexport const ResumeParserAlgorithmArticle = ({\n textItems,\n lines,\n sections,\n}: {\n textItems: TextItems;\n lines: Lines;\n sections: ResumeSectionToLines;\n}) => {\n const getBadgeContent = (item: TextItem) => {\n const X1 = Math.round(item.x);\n const X2 = Math.round(item.x + item.width);\n const Y = Math.round(item.y);\n let content = `X₁=${X1} X₂=${X2} Y=${Y}`;\n if (X1 === X2) {\n content = `X=${X2} Y=${Y}`;\n }\n if (isBold(item)) {\n content = `${content} Bold`;\n }\n if (item.hasEOL) {\n content = `${content} NewLine`;\n }\n return content;\n };\n const step1TextItemsTable = [\n [\"#\", \"Text Content\", \"Metadata\"],\n ...textItems.map((item, idx) => [\n idx + 1,\n item.text,\n {getBadgeContent(item)},\n ]),\n ];\n\n const step2LinesTable = [\n [\"Lines\", \"Line Content\"],\n ...lines.map((line, idx) => [\n idx + 1,\n line.map((item, idx) => (\n \n {item.text}\n {idx !== line.length - 1 && (\n \n {\"|\"} \n \n )}\n \n )),\n ]),\n ];\n\n const { profile, profileScores } = extractProfile(sections);\n const Scores = ({ scores }: { scores: TextScores }) => {\n return (\n <>\n {scores\n .sort((a, b) => b.score - a.score)\n .map((item, idx) => (\n \n {item.score} {item.text}\n \n \n ))}\n \n );\n };\n const step4ProfileFeatureScoresTable = [\n [\n \"Resume Attribute\",\n \"Text (Highest Feature Score)\",\n \"Feature Scores of Other Texts\",\n ],\n [\"Name\", profile.name, ],\n [\n \"Email\",\n profile.email,\n ,\n ],\n [\n \"Phone\",\n profile.phone,\n ,\n ],\n ];\n\n return (\n \n \n Resume Parser Algorithm Deep Dive\n \n \n For the technical curious, this section will dive into the OpenResume\n parser algorithm and walks through the 4 steps on how it works. (Note\n that the algorithm is designed to parse single column resume in English\n language)\n \n {/* Step 1. Read the text items from a PDF file */}\n Step 1. Read the text items from a PDF file\n \n A PDF file is a standardized file format defined by the{\" \"}\n \n ISO 32000 specification\n \n . When you open up a PDF file using a text editor, you'll notice that\n the raw content looks encoded and is difficult to read. To display it in\n a readable format, you would need a PDF reader to decode and view the\n file. Similarly, the resume parser first needs to decode the PDF file in\n order to extract its text content.\n \n \n While it is possible to write a custom PDF reader function following the\n ISO 32000 specification, it is much simpler to leverage an existing\n library. In this case, the resume parser uses Mozilla's open source{\" \"}\n pdf.js library to\n first extract all the text items in the file.\n \n \n The table below lists {textItems.length} text items that are extracted\n from the resume PDF added. A text item contains the text content and\n also some metadata about the content, e.g. its x, y positions in the\n document, whether the font is bolded, or whether it starts a new line.\n (Note that x,y position is relative to the bottom left corner of the\n page, which is the origin 0,0)\n \n
\n \n
\n {/* Step 2. Group text items into lines */}\n Step 2. Group text items into lines\n \n The extracted text items aren't ready to use yet and have 2 main issues:\n \n \n \n Issue 1: They have some unwanted noises.\n \n Some single text items can get broken into multiple ones, as you might\n observe on the table above, e.g. a phone number \"(123) 456-7890\" might\n be broken into 3 text items \"(123) 456\", \"-\" and \"7890\".\n \n \n Solution: To tackle this issue,\n the resume parser connects adjacent text items into one text item if\n their distance is smaller than the average typical character width,\n where\n \n \n Distance \n =\n RightTextItemX₁\n -\n LeftTextItemX₂\n \n `,\n }}\n className=\"my-2 block text-left text-base\"\n />\n The average typical character width is calculated by dividing the sum of\n all text items' widths by the total number characters of the text items\n (Bolded texts and new line elements are excluded to not skew the\n results).\n \n \n \n Issue 2: They lack contexts and associations.\n \n When we read a resume, we scan a resume line by line. Our brains can\n process each section via visual cues such as texts' boldness and\n proximity, where we can quickly associate texts closer together to be a\n related group. The extracted text items however currently don't have\n those contexts/associations and are just disjointed elements.\n \n \n Solution: To tackle this issue,\n the resume parser reconstructs those contexts and associations similar\n to how our brain would read and process the resume. It first groups text\n items into lines since we read text line by line. It then groups lines\n into sections, which will be discussed in the next step.\n \n \n At the end of step 2, the resume parser extracts {lines.length} lines\n from the resume PDF added, as shown in the table below. The result is\n much more readable when displayed in lines. (Some lines might have\n multiple text items, which are separated by a blue vertical divider{\" \"}\n \n {\"|\"} \n \n )\n \n
\n
\n
\n {/* Step 3. Group lines into sections */}\n Step 3. Group lines into sections\n \n At step 2, the resume parser starts building contexts and associations\n to text items by first grouping them into lines. Step 3 continues the\n process to build additional associations by grouping lines into\n sections.\n \n \n Note that every section (except the profile section) starts with a\n section title that takes up the entire line. This is a common pattern\n not just in resumes but also in books and blogs. The resume parser uses\n this pattern to group lines into the closest section title above these\n lines.\n \n \n The resume parser applies some heuristics to detect a section title. The\n main heuristic to determine a section title is to check if it fulfills\n all 3 following conditions: \n 1. It is the only text item in the line \n 2. It is bolded \n 3. Its letters are all UPPERCASE\n \n \n \n In simple words, if a text item is double emphasized to be both bolded\n and uppercase, it is most likely a section title in a resume. This is\n generally true for a well formatted resume. There can be exceptions, but\n it is likely not a good use of bolded and uppercase in those cases.\n \n \n The resume parser also has a fallback heuristic if the main heuristic\n doesn't apply. The fallback heuristic mainly performs a keyword matching\n against a list of common resume section title keywords.\n \n \n At the end of step 3, the resume parser identifies the sections from the\n resume and groups those lines with the associated section title, as\n shown in the table below. Note that{\" \"}\n the section titles are bolded and{\" \"}\n \n the lines associated with the section are highlighted with the same\n colors\n \n .\n \n \n {/* Step 4. Extract resume from sections */}\n Step 4. Extract resume from sections\n \n Step 4 is the last step of the resume parsing process and is also the\n core of the resume parser, where it extracts resume information from the\n sections.\n \n Feature Scoring System\n \n The gist of the extraction engine is a feature scoring system. Each\n resume attribute to be extracted has a custom feature sets, where each\n feature set consists of a feature matching function and a feature\n matching score if matched (feature matching score can be a positive or\n negative number). To compute the final feature score of a text item for\n a particular resume attribute, it would run the text item through all\n its feature sets and sum up the matching feature scores. This process is\n carried out for all text items within the section, and the text item\n with the highest computed feature score is identified as the extracted\n resume attribute.\n \n \n As a demonstration, the table below shows 3 resume attributes in the\n profile section of the resume PDF added.\n \n
\n {(profileScores.name.find((item) => item.text === profile.name)?.score ||\n 0) > 0 && (\n \n In the resume PDF added, the resume attribute name is likely to be \"\n {profile.name}\" since its feature score is{\" \"}\n {profileScores.name.find((item) => item.text === profile.name)?.score}\n , which is the highest feature score out of all text items in the\n profile section. (Some text items' feature scores can be negative,\n indicating they are very unlikely to be the targeted attribute)\n \n )}\n Feature Sets\n \n Having explained the feature scoring system, we can dive more into how\n feature sets are constructed for a resume attribute. It follows 2\n principles: \n 1. A resume attribute's feature sets are designed relative to all other\n resume attributes within the same section. \n 2. A resume attribute's feature sets are manually crafted based on its\n characteristics and likelihood of each characteristic.\n \n \n The table below lists some of the feature sets for the resume attribute\n name. It contains feature function that matches the name attribute with\n positive feature score and also feature function that only matches other\n resume attributes in the section with negative feature score.\n \n \n Core Feature Function\n \n Each resume attribute has multiple feature sets. They can be found in\n the source code under the extract-resume-from-sections folder and we\n won't list them all out here. Each resume attribute usually has a core\n feature function that greatly identifies them, so we will list out the\n core feature function below.\n \n
\n Special Case: Subsections\n \n The last thing that is worth mentioning is subsections. For profile\n section, we can directly pass all the text items to the feature scoring\n systems. But for other sections, such as education and work experience,\n we have to first divide the section into subsections since there can be\n multiple schools or work experiences in the section. The feature scoring\n system then process each subsection to retrieve each's resume attributes\n and append the results.\n \n \n The resume parser applies some heuristics to detect a subsection. The\n main heuristic to determine a subsection is to check if the vertical\n line gap between 2 lines is larger than the typical line gap * 1.4,\n since a well formatted resume usually creates a new empty line break\n before adding the next subsection. There is also a fallback heuristic if\n the main heuristic doesn't apply to check if the text item is bolded.\n \n \n And that is everything about the OpenResume parser algorithm :)\n \n \n Written by Xitang on\n June 2023\n \n \n );\n};\n\nconst step4NameFeatureSetsTable = [\n [\"Feature Function\", \"Feature Matching Score\"],\n [\"Contains only letters, spaces or periods\", \"+3\"],\n [\"Is bolded\", \"+2\"],\n [\"Contains all uppercase letters\", \"+2\"],\n [\"Contains @\", \"-4 (match email)\"],\n [\"Contains number\", \"-4 (match phone)\"],\n [\"Contains ,\", \"-4 (match address)\"],\n [\"Contains /\", \"-4 (match url)\"],\n];\n\nconst step4CoreFeatureFunctionTable = [\n [\"Resume Attribute\", \"Core Feature Function\", \"Regex\"],\n [\"Name\", \"Contains only letters, spaces or periods\", \"/^[a-zA-Z\\\\s\\\\.]+$/\"],\n [\n \"Email\",\n <>\n Match email format xxx@xxx.xxx\n \n xxx can be anything not space\n ,\n \"/\\\\S+@\\\\S+\\\\.\\\\S+/\",\n ],\n [\n \"Phone\",\n <>\n Match phone format (xxx)-xxx-xxxx () and - are optional\n ,\n \"/\\\\(?\\\\d{3}\\\\)?[\\\\s-]?\\\\d{3}[\\\\s-]?\\\\d{4}/\",\n ],\n [\n \"Location\",\n <>Match city and state format {\"City, ST\"},\n \"/[A-Z][a-zA-Z\\\\s]+, [A-Z]{2}/\",\n ],\n [\"Url\", \"Match url format xxx.xxx/xxx\", \"/\\\\S+\\\\.[a-z]+\\\\/\\\\S+/\"],\n [\"School\", \"Contains a school keyword, e.g. College, University, School\", \"\"],\n [\"Degree\", \"Contains a degree keyword, e.g. Associate, Bachelor, Master\", \"\"],\n [\"GPA\", \"Match GPA format x.xx\", \"/[0-4]\\\\.\\\\d{1,2}/\"],\n [\n \"Date\",\n \"Contains date keyword related to year, month, seasons or the word Present\",\n \"Year: /(?:19|20)\\\\d{2}/\",\n ],\n [\n \"Job Title\",\n \"Contains a job title keyword, e.g. Analyst, Engineer, Intern\",\n \"\",\n ],\n [\"Company\", \"Is bolded or doesn't match job title & date\", \"\"],\n [\"Project\", \"Is bolded or doesn't match date\", \"\"],\n];\n\nconst Step3SectionsTable = ({\n sections,\n}: {\n sections: ResumeSectionToLines;\n}) => {\n const table: React.ReactNode[][] = [[\"Lines\", \"Line Content\"]];\n const trClassNames = [];\n let lineCounter = 0;\n const BACKGROUND_COLORS = [\n \"bg-red-50\",\n \"bg-yellow-50\",\n \"bg-orange-50\",\n \"bg-green-50\",\n \"bg-blue-50\",\n \"bg-purple-50\",\n ] as const;\n const sectionsEntries = Object.entries(sections);\n\n const Line = ({ line }: { line: Line }) => {\n return (\n <>\n {line.map((item, idx) => (\n \n {item.text}\n {idx !== line.length - 1 && (\n \n {\"|\"} \n \n )}\n \n ))}\n \n );\n };\n\n for (let i = 0; i < sectionsEntries.length; i++) {\n const sectionBackgroundColor = BACKGROUND_COLORS[i % 6];\n const [sectionTitle, lines] = sectionsEntries[i];\n table.push([\n sectionTitle === \"profile\" ? \"\" : lineCounter,\n sectionTitle === \"profile\" ? \"PROFILE\" : sectionTitle,\n ]);\n trClassNames.push(`${sectionBackgroundColor} font-bold`);\n lineCounter += 1;\n for (let j = 0; j < lines.length; j++) {\n table.push([lineCounter, ]);\n trClassNames.push(sectionBackgroundColor);\n lineCounter += 1;\n }\n }\n\n return (\n
\n \n
\n );\n};\n"
},
{
"path": "src/app/resume-parser/ResumeTable.tsx",
"content": "import { Fragment } from \"react\";\nimport type { Resume } from \"lib/redux/types\";\nimport { initialEducation, initialWorkExperience } from \"lib/redux/resumeSlice\";\nimport { deepClone } from \"lib/deep-clone\";\nimport { cx } from \"lib/cx\";\n\nconst TableRowHeader = ({ children }: { children: React.ReactNode }) => (\n
\n );\n};\n"
},
{
"path": "src/app/resume-parser/page.tsx",
"content": "\"use client\";\nimport { useState, useEffect } from \"react\";\nimport { readPdf } from \"lib/parse-resume-from-pdf/read-pdf\";\nimport type { TextItems } from \"lib/parse-resume-from-pdf/types\";\nimport { groupTextItemsIntoLines } from \"lib/parse-resume-from-pdf/group-text-items-into-lines\";\nimport { groupLinesIntoSections } from \"lib/parse-resume-from-pdf/group-lines-into-sections\";\nimport { extractResumeFromSections } from \"lib/parse-resume-from-pdf/extract-resume-from-sections\";\nimport { ResumeDropzone } from \"components/ResumeDropzone\";\nimport { cx } from \"lib/cx\";\nimport { Heading, Link, Paragraph } from \"components/documentation\";\nimport { ResumeTable } from \"resume-parser/ResumeTable\";\nimport { FlexboxSpacer } from \"components/FlexboxSpacer\";\nimport { ResumeParserAlgorithmArticle } from \"resume-parser/ResumeParserAlgorithmArticle\";\n\nconst RESUME_EXAMPLES = [\n {\n fileUrl: \"resume-example/laverne-resume.pdf\",\n description: (\n \n Borrowed from University of La Verne Career Center -{\" \"}\n \n Link\n \n \n ),\n },\n {\n fileUrl: \"resume-example/openresume-resume.pdf\",\n description: (\n \n Created with OpenResume resume builder -{\" \"}\n Link\n \n ),\n },\n];\n\nconst defaultFileUrl = RESUME_EXAMPLES[0][\"fileUrl\"];\nexport default function ResumeParser() {\n const [fileUrl, setFileUrl] = useState(defaultFileUrl);\n const [textItems, setTextItems] = useState([]);\n const lines = groupTextItemsIntoLines(textItems || []);\n const sections = groupLinesIntoSections(lines);\n const resume = extractResumeFromSections(sections);\n\n useEffect(() => {\n async function test() {\n const textItems = await readPdf(fileUrl);\n setTextItems(textItems);\n }\n test();\n }, [fileUrl]);\n\n return (\n \n
\n
\n \n
\n \n
\n \n \n
\n
\n \n \n \n Resume Parser Playground\n \n \n This playground showcases the OpenResume resume parser and its\n ability to parse information from a resume PDF. Click around the\n PDF examples below to observe different parsing results.\n \n
\n \n You can also{\" \"}\n add your resume below to\n access how well your resume would be parsed by similar Application\n Tracking Systems (ATS) used in job applications. The more\n information it can parse out, the better it indicates the resume\n is well formatted and easy to read. It is beneficial to have the\n name and email accurately parsed at the very least.\n \n