├── .eslintrc.json ├── .gitignore ├── LICENSE ├── README.md ├── app ├── actions.tsx ├── favicon.ico ├── globals.css ├── layout.tsx ├── page.tsx └── schema.ts ├── components.json ├── components ├── download-button.tsx ├── file-card.tsx ├── file-input.tsx ├── flashcard-dialog.tsx ├── flashcard.tsx └── ui │ ├── button.tsx │ ├── card.tsx │ ├── dialog.tsx │ ├── form.tsx │ ├── input.tsx │ ├── label.tsx │ ├── select.tsx │ ├── separator.tsx │ ├── skeleton.tsx │ ├── sonner.tsx │ ├── textarea.tsx │ ├── toast.tsx │ ├── toaster.tsx │ ├── tooltip.tsx │ └── use-toast.ts ├── lib ├── anki │ ├── Card.ts │ ├── Deck.ts │ ├── Model.ts │ ├── Note.ts │ ├── Package.ts │ ├── apkg_col.ts │ ├── apkg_schema.ts │ ├── builtin-models.ts │ └── util.ts ├── langfuse.ts └── utils.ts ├── next.config.mjs ├── package-lock.json ├── package.json ├── postcss.config.mjs ├── public ├── flashcards.png └── md2anki.gif ├── tailwind.config.ts └── tsconfig.json /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "next/core-web-vitals" 3 | } 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | .env 3 | 4 | # dependencies 5 | /node_modules 6 | /.pnp 7 | .pnp.js 8 | .yarn/install-state.gz 9 | 10 | # testing 11 | /coverage 12 | 13 | # next.js 14 | /.next/ 15 | /out/ 16 | 17 | # production 18 | /build 19 | 20 | # misc 21 | .DS_Store 22 | *.pem 23 | 24 | # debug 25 | npm-debug.log* 26 | yarn-debug.log* 27 | yarn-error.log* 28 | 29 | # local env files 30 | .env*.local 31 | 32 | # vercel 33 | .vercel 34 | 35 | # typescript 36 | *.tsbuildinfo 37 | next-env.d.ts 38 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # md2anki: AI-Powered Anki Flashcard Generator 2 | ![GitHub License](https://img.shields.io/github/license/lucagrippa/md2anki) 3 | 4 | 5 | md2anki is an open-source web app that uses AI to generate Anki flashcards from Markdown files, making it easier to turn your notes into study materials. 6 | 7 | Built with the [Vercel AI SDK](https://sdk.vercel.ai), [GPT-4o-mini](https://platform.openai.com/docs/models/gpt-4o-mini), [Next.js](https://nextjs.org), [Langfuse](https://langfuse.com), and [Seline.so](https://seline.so). 8 | 9 | [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fhello-world&env=OPENAI_API_KEY,OPENAI_MODEL,LANGFUSE_SECRET_KEY,LANGFUSE_PUBLIC_KEY,LANGFUSE_HOST&project-name=md2anki&repository-name=md2anki) 10 | 11 | 12 | ![How to use md2anki](public/md2anki.gif) 13 | 14 | ## Usage 15 | 16 | 1. Upload a Markdown file containing the content you want to convert into flashcards. 17 | 2. Click the "Generate flashcards" button to start the AI-powered generation process. 18 | 3. Review and edit the generated flashcards as needed. 19 | 4. Download the flashcards as an Anki-compatible `.apkg` file. 20 | 5. Import the `.apkg` file into Anki to start studying! 21 | 22 | ## Development 23 | 24 | ### Prerequisites 25 | 26 | - Node.js (v14 or later) 27 | - npm or yarn 28 | - OpenAI API key 29 | - (Optional) Seline.so and Langfuse accounts for analytics 30 | 31 | ### Installation 32 | 33 | 1. Clone the repository: 34 | ```bash 35 | git clone https://github.com/yourusername/md2anki.git 36 | cd md2anki 37 | ``` 38 | 39 | 2. Install dependencies: 40 | ```bash 41 | npm install 42 | ``` 43 | or 44 | ```bash 45 | yarn install 46 | ``` 47 | 48 | 3. Set up environment variables: 49 | Create a `.env.local` file in the root directory and add the following: 50 | ```env 51 | OPENAI_API_KEY=your_openai_api_key 52 | OPENAI_MODEL=your_openai_model (optional, defaults to `gpt-4o-mini-2024-07-18`) 53 | LANGFUSE_PUBLIC_KEY=your_langfuse_public_key (optional) 54 | LANGFUSE_SECRET_KEY=your_langfuse_secret_key (optional) 55 | LANGFUSE_HOST=your_langfuse_host (optional) 56 | ``` 57 | 58 | 4. Run the development server: 59 | ```bash 60 | npm run dev 61 | ``` 62 | or 63 | ```bash 64 | yarn dev 65 | ``` 66 | 67 | 5. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application. 68 | 69 | ## Contributing 70 | 71 | Contributions are welcome! Please feel free to submit a Pull Request. 72 | 73 | ## License 74 | 75 | This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for details. 76 | 77 | -------------------------------------------------------------------------------- /app/actions.tsx: -------------------------------------------------------------------------------- 1 | 'use server'; 2 | 3 | import { createOpenAI, OpenAIProvider } from '@ai-sdk/openai'; 4 | import { streamObject, CoreSystemMessage, CoreUserMessage, CompletionTokenUsage, CallWarning } from 'ai'; 5 | import { createStreamableValue } from 'ai/rsc'; 6 | import { PartialGeneration, generationSchema } from './schema'; 7 | import { getLangfuse, fetchPrompt } from '../lib/langfuse'; 8 | import { LangfuseGenerationClient, LangfuseTraceClient } from "langfuse"; 9 | import { kv } from '@vercel/kv'; 10 | import crypto from 'crypto'; 11 | 12 | // Constants 13 | const WORDS_PER_PAGE = 500; 14 | const API_KEY = process.env.OPENAI_API_KEY; 15 | const MODEL = process.env.OPENAI_MODEL || "gpt-4o-mini-2024-07-18"; 16 | const PROMPT_NAME = process.env.PROMPT_NAME || "generate-deck-system"; 17 | 18 | /** 19 | * Generates a hash of the given content. 20 | * @param content - The content to be hashed. 21 | * @returns A SHA-256 hash of the content. 22 | */ 23 | function generateHash(content: string): string { 24 | return crypto.createHash('sha256').update(content).digest('hex'); 25 | } 26 | 27 | /** 28 | * Caches the response for future use. 29 | * @param key - The key to store the cache under. 30 | * @param finalCards - The final flashcards to be cached. 31 | */ 32 | async function cacheResponse(key: string, finalCards: PartialGeneration): Promise { 33 | await kv.set(key, finalCards); 34 | await kv.expire(key, 60 * 60); // Cache for 1 hour 35 | } 36 | 37 | /** 38 | * Splits a document into pages based on a specified number of words per page. 39 | * @param content - The content to be paginated. 40 | * @param wordsPerPage - The number of words per page. 41 | * @returns An array of strings, each representing a page. 42 | */ 43 | function paginateDocument(content: string, wordsPerPage: number): string[] { 44 | const words = content.split(/\s+/); 45 | const pages: string[] = []; 46 | 47 | for (let i = 0; i < words.length; i += wordsPerPage) { 48 | pages.push(words.slice(i, i + wordsPerPage).join(' ')); 49 | } 50 | 51 | return pages; 52 | } 53 | 54 | /** 55 | * Processes each page of the document to generate flashcards. 56 | * @param pages - An array of document pages. 57 | * @param promptInfo - Information about the prompt to be used. 58 | * @param MODEL - The AI model to be used. 59 | * @param trace - The Langfuse trace client. 60 | * @param openai - The OpenAI provider. 61 | * @param finalCards - The object to store the generated flashcards. 62 | * @param stream - The stream to update with partial results. 63 | */ 64 | async function processPages( 65 | pages: string[], 66 | promptInfo: { promptLink: any; promptTemplate: string }, 67 | trace: LangfuseTraceClient, 68 | openai: OpenAIProvider, 69 | finalCards: PartialGeneration, 70 | stream: any 71 | ): Promise { 72 | for (const page of pages) { 73 | const messages: (CoreSystemMessage | CoreUserMessage)[] = [ 74 | { role: "system", content: promptInfo.promptTemplate }, 75 | { role: "user", content: page } 76 | ]; 77 | 78 | const generation = trace.generation({ 79 | name: "generation", 80 | input: messages, 81 | model: MODEL, 82 | prompt: promptInfo.promptLink, 83 | completionStartTime: new Date(), 84 | }); 85 | 86 | try { 87 | await streamObject({ 88 | model: openai(MODEL), 89 | messages: messages, 90 | schema: generationSchema, 91 | mode: "tool", 92 | temperature: 0.0, 93 | onFinish: async (event) => updateGeneration(finalCards, event, generation), 94 | }) 95 | .then(async ({ partialObjectStream }) => { 96 | for await (const partialObject of partialObjectStream) { 97 | stream.update({ 98 | deck_name: partialObject.deck_name !== undefined 99 | ? partialObject.deck_name 100 | : finalCards?.deck_name, 101 | flashcards: [...(finalCards?.flashcards ?? []), ...(partialObject.flashcards ?? [])] 102 | }); 103 | } 104 | }); 105 | } catch (error) { 106 | console.error('Error in partialObjectStream:', error); 107 | trace.update({ output: error instanceof Error ? error : new Error(String(error)) }); 108 | } 109 | } 110 | 111 | trace.update({ output: finalCards }); 112 | } 113 | 114 | /** 115 | * Updates the generation with the latest flashcards and handles any errors. 116 | * @param finalCards - The object to store the final flashcards. 117 | * @param event - The event containing the latest generated flashcards or error. 118 | * @param generation - The Langfuse generation client. 119 | */ 120 | async function updateGeneration( 121 | finalCards: PartialGeneration, 122 | event: { 123 | usage: CompletionTokenUsage; 124 | object: PartialGeneration | undefined; 125 | error: unknown | undefined; 126 | rawResponse?: { headers?: Record }; 127 | warnings?: CallWarning[]; 128 | }, 129 | generation: LangfuseGenerationClient 130 | ): Promise { 131 | if (event.error) { 132 | console.error('Error in stream:', event.error); 133 | } 134 | 135 | if (event.object?.flashcards) { 136 | console.log(`Received ${event.object.flashcards.length} flashcards`); 137 | // Update deck_name if it's null, undefined, or an empty string 138 | if (!finalCards.deck_name) { 139 | finalCards.deck_name = event.object.deck_name; 140 | } 141 | 142 | // Update flashcards by merging existing ones with new ones 143 | finalCards.flashcards = [...(finalCards.flashcards ?? []), ...event.object.flashcards]; 144 | 145 | generation.update({ 146 | endTime: new Date(), 147 | output: event.object, 148 | }); 149 | } else { 150 | console.warn('No valid object generated'); 151 | } 152 | } 153 | 154 | 155 | /** 156 | * Generates an Anki deck based on the provided document content. 157 | * @param documentContent The content of the document to generate cards from. 158 | * @param apiKey The API key for OpenAI. 159 | * @returns A stream of partial card objects. 160 | */ 161 | export async function generateFlashcards(documentContent: string) { 162 | if (!API_KEY) { 163 | throw new Error("OPENAI_API_KEY is not set in the environment variables."); 164 | } 165 | 166 | // const key = JSON.stringify(documentContent); 167 | const key = generateHash(documentContent); 168 | const langfuse = getLangfuse() 169 | const stream = createStreamableValue(); 170 | const openai = createOpenAI({ apiKey: API_KEY }); 171 | 172 | // Uncomment the following block to enable caching 173 | // const cached = await kv.get(key); 174 | // if (cached) { 175 | // console.log(`Fetching cached response for key: ${key}`); 176 | // stream.update(cached); 177 | // stream.done(); 178 | // return stream.value; 179 | // } 180 | 181 | const trace = langfuse.trace({ 182 | name: "Generate Flashcards", 183 | input: documentContent 184 | }); 185 | 186 | const pages = paginateDocument(documentContent, WORDS_PER_PAGE); 187 | console.log(`Split document into ${pages.length} pages`); 188 | 189 | try { 190 | const promptInfo = await fetchPrompt(trace, PROMPT_NAME, langfuse) 191 | const finalCards: PartialGeneration = { deck_name: "", flashcards: [] }; 192 | 193 | processPages(pages, promptInfo, trace, openai, finalCards, stream) 194 | .finally(async () => { 195 | stream.done(); 196 | await langfuse.flushAsync(); 197 | }); 198 | 199 | // Uncomment the following line to enable caching 200 | // await cacheResponse(key, finalCards); 201 | } catch (error) { 202 | console.error('Error in generating flashcards:', error); 203 | trace.update({ output: error instanceof Error ? error : new Error(String(error)) }); 204 | stream.error(error); 205 | } 206 | 207 | return { object: stream.value }; 208 | } 209 | -------------------------------------------------------------------------------- /app/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lucagrippa/md2anki/3a4fe2fc62c6dd05497c2572418edc23e6d386bc/app/favicon.ico -------------------------------------------------------------------------------- /app/globals.css: -------------------------------------------------------------------------------- 1 | @tailwind base; 2 | @tailwind components; 3 | @tailwind utilities; 4 | 5 | @layer base { 6 | :root { 7 | --background: 0 0% 100%; 8 | --foreground: 0 0% 3.9%; 9 | 10 | --card: 0 0% 100%; 11 | --card-foreground: 0 0% 3.9%; 12 | 13 | --popover: 0 0% 100%; 14 | --popover-foreground: 0 0% 3.9%; 15 | 16 | --primary: 0 0% 9%; 17 | --primary-foreground: 0 0% 98%; 18 | 19 | --secondary: 0 0% 96.1%; 20 | --secondary-foreground: 0 0% 9%; 21 | 22 | --muted: 0 0% 96.1%; 23 | --muted-foreground: 0 0% 45.1%; 24 | 25 | --accent: 0 0% 96.1%; 26 | --accent-foreground: 0 0% 9%; 27 | 28 | --destructive: 0 84.2% 60.2%; 29 | --destructive-foreground: 0 0% 98%; 30 | 31 | --border: 0 0% 89.8%; 32 | --input: 0 0% 89.8%; 33 | --ring: 0 0% 3.9%; 34 | 35 | --radius: 0.5rem; 36 | } 37 | 38 | .dark { 39 | --background: 0 0% 3.9%; 40 | --foreground: 0 0% 98%; 41 | 42 | --card: 0 0% 3.9%; 43 | --card-foreground: 0 0% 98%; 44 | 45 | --popover: 0 0% 3.9%; 46 | --popover-foreground: 0 0% 98%; 47 | 48 | --primary: 0 0% 98%; 49 | --primary-foreground: 0 0% 9%; 50 | 51 | --secondary: 0 0% 14.9%; 52 | --secondary-foreground: 0 0% 98%; 53 | 54 | --muted: 0 0% 14.9%; 55 | --muted-foreground: 0 0% 63.9%; 56 | 57 | --accent: 0 0% 14.9%; 58 | --accent-foreground: 0 0% 98%; 59 | 60 | --destructive: 0 62.8% 30.6%; 61 | --destructive-foreground: 0 0% 98%; 62 | 63 | --border: 0 0% 14.9%; 64 | --input: 0 0% 14.9%; 65 | --ring: 0 0% 83.1%; 66 | } 67 | } 68 | 69 | @layer base { 70 | * { 71 | @apply border-border; 72 | } 73 | 74 | body { 75 | @apply bg-background text-foreground; 76 | } 77 | } -------------------------------------------------------------------------------- /app/layout.tsx: -------------------------------------------------------------------------------- 1 | import type { Metadata } from "next"; 2 | import { Toaster } from "@/components/ui/toaster" 3 | import { Inter } from "next/font/google"; 4 | import "./globals.css"; 5 | 6 | const inter = Inter({ subsets: ["latin"] }); 7 | 8 | export const metadata: Metadata = { 9 | title: "md2anki", 10 | description: "Generate Anki flashcards from markdown", 11 | }; 12 | 13 | export default function RootLayout({ 14 | children, 15 | }: Readonly<{ 16 | children: React.ReactNode; 17 | }>) { 18 | return ( 19 | 20 | 21 |
22 | {children} 23 |
24 | 44 | 45 | 46 | 47 | ); 48 | } 49 | -------------------------------------------------------------------------------- /app/page.tsx: -------------------------------------------------------------------------------- 1 | "use client"; 2 | import * as seline from '@seline-analytics/web'; 3 | 4 | import { useState } from "react"; 5 | import { useForm } from "react-hook-form"; 6 | import { zodResolver } from "@hookform/resolvers/zod"; 7 | import { z } from "zod"; 8 | import { readStreamableValue } from "ai/rsc"; 9 | import { ArrowDownToLine, Sparkles, RefreshCw } from 'lucide-react'; 10 | import log from 'loglevel'; 11 | 12 | // UI component imports 13 | import { 14 | Form, 15 | FormControl, 16 | FormField, 17 | FormItem, 18 | FormMessage, 19 | } from "@/components/ui/form"; 20 | import { 21 | Tooltip, 22 | TooltipContent, 23 | TooltipProvider, 24 | TooltipTrigger, 25 | } from "@/components/ui/tooltip" 26 | import { ToastAction } from "@/components/ui/toast"; 27 | import { useToast } from "@/components/ui/use-toast"; 28 | import { Button } from "@/components/ui/button"; 29 | 30 | // Custom component imports 31 | import { generateFlashcards } from "./actions"; 32 | import { PartialGeneration, isValidFlashcard } from "./schema"; 33 | import { FileCard } from "../components/file-card"; 34 | import { FileInput } from "../components/file-input"; 35 | import { Flashcard } from "../components/flashcard"; 36 | 37 | // Anki-related imports 38 | import { BASIC_MODEL, BASIC_AND_REVERSED_CARD_MODEL, CLOZE_MODEL } from '../lib/anki/builtin-models'; 39 | import Deck from '../lib/anki/Deck'; 40 | import { Note } from '../lib/anki/Note'; 41 | import { Package } from '../lib/anki/Package'; 42 | 43 | // Configuration 44 | export const dynamic = "force-dynamic"; 45 | export const maxDuration = 60; 46 | 47 | // Set log level based on environment 48 | if (process.env.NODE_ENV === 'development') { 49 | log.setLevel('debug'); 50 | } else { 51 | log.setLevel('error'); 52 | } 53 | 54 | // Form schema definition 55 | const formSchema = z.object({ 56 | document: z.instanceof(File).optional(), 57 | }) 58 | type FormValues = z.infer 59 | 60 | export default function GenerateDeck() { 61 | seline.init(); 62 | const { toast } = useToast() 63 | const [file, setFile] = useState(null); 64 | const [generation, setGeneration] = useState({ deck_name: "", flashcards: [] }); 65 | const [isLoading, setIsLoading] = useState(null); 66 | 67 | const form = useForm({ 68 | resolver: zodResolver(formSchema), 69 | defaultValues: { 70 | document: undefined, 71 | }, 72 | }); 73 | 74 | // File handling functions 75 | const handleFileChange = async (file: File) => { 76 | setFile(file); 77 | }; 78 | 79 | const handleFileRemove = async (event: React.MouseEvent) => { 80 | setFile(null); // Clear the file 81 | }; 82 | 83 | const handleFlashcardGeneration = async (text: string) => { 84 | try { 85 | setIsLoading(true); // Set loading state to true 86 | 87 | toast({ 88 | description: "Generating your Anki deck...", 89 | }); 90 | 91 | const { object } = await generateFlashcards(text); 92 | for await (const partialObject of readStreamableValue(object)) { 93 | if (partialObject) { 94 | setGeneration(partialObject); 95 | } 96 | } 97 | setIsLoading(false); // Set loading state to false when donesetIsLoading(false); // Set loading state to false when done 98 | } catch (error) { 99 | console.error("Error generating deck:", error); 100 | toast({ 101 | description: "Failed to generate Anki deck. Please try again.", 102 | variant: "destructive", 103 | }); 104 | } 105 | }; 106 | 107 | // Form submission handler 108 | const onSubmit = async (values: z.infer) => { 109 | log.debug(values) 110 | if (!file) { 111 | toast({ 112 | description: "Please upload a markdown file", 113 | variant: "destructive", 114 | }); 115 | return; 116 | } 117 | 118 | const text = await file.text(); 119 | seline.track("user: generate", { file: file.name }); 120 | await handleFlashcardGeneration(text); 121 | } 122 | 123 | const regenerateFlashcards = async () => { 124 | setGeneration({ deck_name: "", flashcards: [] }); 125 | 126 | if (!file) { 127 | toast({ 128 | description: "Regenerate not available", 129 | variant: "destructive", 130 | }); 131 | return; 132 | } 133 | 134 | const text = await file.text(); 135 | seline.track("user: regenerate", { file: file.name }); 136 | await handleFlashcardGeneration(text); 137 | }; 138 | 139 | const updateFlashcard = (index: number, updatedFlashcard: { question: string; answer: string }) => { 140 | setGeneration(prevState => { 141 | const newFlashcards = [...(prevState.flashcards || [])]; 142 | seline.track("user: update card", { 143 | question: newFlashcards[index]?.question, 144 | answer: newFlashcards[index]?.answer, 145 | updated_question: updatedFlashcard.question, 146 | updated_answer: updatedFlashcard.answer, 147 | }); 148 | newFlashcards[index] = updatedFlashcard; 149 | return { flashcards: newFlashcards }; 150 | }); 151 | }; 152 | 153 | const deleteFlashcard = (index: number, event?: React.MouseEvent) => { 154 | if (event) { 155 | event.stopPropagation(); // Prevent the event from bubbling up and the card's onClick from firing 156 | } 157 | 158 | let deletedFlashcard: { question: string; answer: string } | undefined; 159 | setGeneration(prevState => { 160 | const newFlashcards = [...(prevState.flashcards || [])]; 161 | if (index >= 0 && index < newFlashcards.length) { 162 | seline.track("user: delete card", { 163 | question: newFlashcards[index]?.question, 164 | answer: newFlashcards[index]?.answer, 165 | }); 166 | const deleted = newFlashcards.splice(index, 1); 167 | if (deleted.length > 0) { 168 | deletedFlashcard = deleted[0] as { question: string; answer: string }; 169 | } 170 | } 171 | return { flashcards: newFlashcards }; 172 | }); 173 | 174 | if (deletedFlashcard) { 175 | toast({ 176 | description: "Flashcard deleted", 177 | variant: "destructive", 178 | action: undoDelete(deletedFlashcard!, index)} 181 | > 182 | Undo 183 | , 184 | }); 185 | } else { 186 | toast({ 187 | description: "Failed to delete flashcard", 188 | variant: "destructive" 189 | }); 190 | } 191 | }; 192 | 193 | const undoDelete = (flashcard: { question: string; answer: string }, index: number) => { 194 | setGeneration(prevState => { 195 | const newFlashcards = [...(prevState.flashcards || [])]; 196 | seline.track("user: undo delete card", { 197 | question: newFlashcards[index]?.question, 198 | answer: newFlashcards[index]?.answer, 199 | }); 200 | newFlashcards.splice(index, 0, flashcard); 201 | return { flashcards: newFlashcards }; 202 | }); 203 | }; 204 | 205 | function downloadDeck(partialGeneration: PartialGeneration) { 206 | log.debug('Downloading deck...'); 207 | 208 | seline.track("user: download", { 209 | file: file?.name, 210 | }); 211 | 212 | // Create a deck and add notes 213 | log.debug(`Deck: ${partialGeneration.deck_name}`); 214 | const deckID = Math.floor(100000 + Math.random() * 900000); 215 | log.debug(`Deck ID: ${deckID}`); 216 | const deckName = partialGeneration?.deck_name || "md2anki Deck"; 217 | const deckDescription = "A deck created using md2anki"; 218 | const myDeck = new Deck(deckID, deckName, deckDescription); 219 | 220 | // Add notes from partialFlashcards 221 | partialGeneration?.flashcards?.forEach((flashcard, index) => { 222 | if (isValidFlashcard(flashcard)) { 223 | // check if flashcard type is basic 224 | if (flashcard.type === 'basic') { 225 | const note = new Note(BASIC_MODEL, [flashcard.question, flashcard.answer], null, flashcard.tags); 226 | myDeck.addNote(note); 227 | } else if (flashcard.type === 'reversible') { 228 | const note = new Note(BASIC_AND_REVERSED_CARD_MODEL, [flashcard.question, flashcard.answer], null, flashcard.tags); 229 | myDeck.addNote(note); 230 | 231 | } else if (flashcard.type === 'cloze') { 232 | const note = new Note(CLOZE_MODEL, [flashcard.question, flashcard.answer], null, flashcard.tags); 233 | myDeck.addNote(note); 234 | } else { 235 | log.warn(`Skipping flashcard at index ${index} with invalid type: ${flashcard.type}`); 236 | } 237 | } else { 238 | log.warn(`Skipping invalid flashcard at index ${index}`); 239 | } 240 | }); 241 | 242 | // Create a package and write to file 243 | const myPackage = new Package(myDeck); 244 | myPackage.writeToFile(`${partialGeneration.deck_name?.toLowerCase().replace(/ /g, '-')}-md2anki.apkg`) 245 | .then(() => log.debug("Anki package created successfully!")) 246 | .catch(error => log.error("Error creating Anki package:", error)); 247 | toast({ 248 | description: "Deck downloaded successfully", 249 | }); 250 | } 251 | 252 | return ( 253 |
254 |

window.location.reload()}> md2anki

255 |
256 |
257 | 258 | {file ? ( 259 | isLoading === null ? ( 260 | <> 261 | 262 | < Button type="submit" disabled={file === null}> 263 | Generate flashcards 264 | 265 | 266 | ) : ( 267 |
268 | 269 |
270 | ) 271 | ) : ( 272 | ( 276 | 277 | 278 | 279 | 280 | 281 | 282 | )} 283 | /> 284 | )} 285 | 286 | 287 | 288 |
289 | {isLoading !== null && ( 290 | <> 291 |
292 | {generation?.flashcards?.length || 0} flashcards 293 | 294 |
295 | 296 | 297 | 298 | 301 | 302 | 303 | Re-generate flashcards 304 | 305 | 306 | 307 | 308 | 309 | 310 | 311 | 314 | 315 | 316 | Download as .apkg 317 | 318 | 319 | 320 |
321 |
322 |
323 | {generation?.flashcards?.map((flashcard, index) => ( 324 | 330 | ))} 331 |
332 | 333 | )} 334 |
335 | ); 336 | } 337 | -------------------------------------------------------------------------------- /app/schema.ts: -------------------------------------------------------------------------------- 1 | import { DeepPartial } from "ai"; 2 | import { z } from "zod"; 3 | 4 | // define a schema for the anki deck cards 5 | export const generationSchema = z.object({ 6 | deck_name: z.string().describe("The name of the deck that the flashcards belong to."), 7 | flashcards: z.array( 8 | z.object({ 9 | question: z.string().describe("The front of the flashcard that contains the question."), 10 | answer: z.string().describe("The back of the flashcard that contains the answer to the question."), 11 | type: z.enum(['basic', 'reversible', 'cloze']).describe("The type of flashcard, 'basic' flashcards have a question and answer, 'reversible' flashcards the question and answer can be swapped, 'cloze' aka cloze deletion flashcards have a part of the question missing and replaced by 3 underscores."), 12 | tags: z.array( 13 | z.string().describe("A tag for categorizing or organizing flashcards.") 14 | ).describe("A list of tags associated with the flashcard, used for categorization or filtering.") 15 | }), 16 | ), 17 | }); 18 | 19 | // define a type for the partial cards during generation 20 | export type PartialGeneration = DeepPartial; 21 | 22 | // Extract the type for a single flashcard 23 | export type Flashcard = z.infer["flashcards"][number]; 24 | 25 | // Create a partial version of the Flashcard type 26 | export type PartialFlashcard = DeepPartial; 27 | 28 | // Type guard function 29 | export function isValidFlashcard(flashcard: unknown): flashcard is Flashcard { 30 | return ( 31 | typeof flashcard === 'object' && 32 | flashcard !== null && 33 | 'question' in flashcard && 34 | 'answer' in flashcard && 35 | 'type' in flashcard && 36 | 'tags' in flashcard && 37 | typeof flashcard.question === 'string' && 38 | typeof flashcard.answer === 'string' && 39 | ['basic', 'reversible', 'cloze'].includes(flashcard.type as string) && 40 | Array.isArray(flashcard.tags) 41 | ); 42 | } -------------------------------------------------------------------------------- /components.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://ui.shadcn.com/schema.json", 3 | "style": "default", 4 | "rsc": true, 5 | "tsx": true, 6 | "tailwind": { 7 | "config": "tailwind.config.ts", 8 | "css": "app/globals.css", 9 | "baseColor": "neutral", 10 | "cssVariables": true, 11 | "prefix": "" 12 | }, 13 | "aliases": { 14 | "components": "@/components", 15 | "utils": "@/lib/utils" 16 | } 17 | } -------------------------------------------------------------------------------- /components/download-button.tsx: -------------------------------------------------------------------------------- 1 | import { ArrowDownToLine } from 'lucide-react'; 2 | import { Button } from "@/components/ui/button" 3 | import { 4 | Tooltip, 5 | TooltipContent, 6 | TooltipProvider, 7 | TooltipTrigger, 8 | } from "@/components/ui/tooltip" 9 | 10 | export function DownloadButton() { 11 | return ( 12 | 13 | 14 | 15 | 18 | 19 | 20 |

Download as .apkg

21 | 22 | 23 | 24 | ) 25 | } 26 | 27 | // Implement the downloadDeck function 28 | function downloadDeck() { 29 | // Logic to download the deck 30 | } -------------------------------------------------------------------------------- /components/file-card.tsx: -------------------------------------------------------------------------------- 1 | import React, { MouseEventHandler } from 'react'; 2 | import { X, File as FileIcon } from 'lucide-react'; 3 | import { Card } from "@/components/ui/card" 4 | import { Button } from "@/components/ui/button" 5 | 6 | interface FileCardProps { 7 | file: File; 8 | handleFileRemove?: (event: React.MouseEvent) => void; 9 | } 10 | 11 | export function FileCard({ file, handleFileRemove }: FileCardProps) { 12 | return ( 13 | 14 |
15 | 16 |
17 | 18 |
19 |
20 |

{file.name}

21 |

{(file.size / 1024).toFixed(2)} KB

22 |
23 |
24 | {handleFileRemove && ( 25 | 29 | )} 30 | 31 | ) 32 | } -------------------------------------------------------------------------------- /components/file-input.tsx: -------------------------------------------------------------------------------- 1 | import { useCallback, useState } from 'react'; 2 | import { UploadIcon } from 'lucide-react'; 3 | 4 | import { Input } from "@/components/ui/input"; 5 | import { useToast } from "@/components/ui/use-toast"; 6 | 7 | type FileInputProps = { 8 | handleFileChange: (file: File) => void; 9 | }; 10 | 11 | export function FileInput({ handleFileChange }: FileInputProps) { 12 | const { toast } = useToast() 13 | const [isDragging, setIsDragging] = useState(false); 14 | 15 | const onDragOver = useCallback((event: React.DragEvent) => { 16 | event.preventDefault(); 17 | setIsDragging(true); 18 | }, []); 19 | 20 | const onDragLeave = useCallback((event: React.DragEvent) => { 21 | event.preventDefault(); 22 | setIsDragging(false); 23 | }, []); 24 | 25 | const onDrop = useCallback((event: React.DragEvent) => { 26 | event.preventDefault(); 27 | setIsDragging(false); 28 | const files = event.dataTransfer.files; 29 | if (files.length > 0) { 30 | if (files[0].name.endsWith('.md')) { 31 | handleFileChange(files[0]); 32 | } else { 33 | toast({ 34 | description: "Unsupported file type. Please upload a markdown (.md) file.", 35 | variant: "destructive", 36 | }); 37 | } 38 | } 39 | }, [handleFileChange]); 40 | 41 | const onChange = useCallback((event: React.ChangeEvent) => { 42 | const files = event.target.files; 43 | if (files && files.length > 0) { 44 | if (files[0].name.endsWith('.md')) { 45 | handleFileChange(files[0]); 46 | } else { 47 | toast({ 48 | description: "Unsupported file type. Please upload a markdown (.md) file.", 49 | variant: "destructive", 50 | }); 51 | } 52 | } 53 | }, [handleFileChange]); 54 | 55 | return ( 56 |
65 |
66 | 67 |

68 | {isDragging ? 'Drop the file here' : 'Click to upload or drag and drop a markdown file'} 69 |

70 |

Supported formats: MD

71 |
72 | 79 |
80 | ) 81 | } -------------------------------------------------------------------------------- /components/flashcard-dialog.tsx: -------------------------------------------------------------------------------- 1 | import { Button } from "@/components/ui/button" 2 | import { 3 | DialogDescription, 4 | DialogFooter, 5 | DialogHeader, 6 | DialogTitle, 7 | DialogClose, 8 | } from "@/components/ui/dialog" 9 | import { Label } from "@/components/ui/label" 10 | import { Textarea } from "@/components/ui/textarea" 11 | 12 | import { PartialFlashcard } from "../app/schema"; 13 | 14 | interface DialogProps { 15 | flashcard: PartialFlashcard | undefined; 16 | index: number; 17 | updateFlashcard: (index: number, flashcard: { question: string; answer: string }) => void; 18 | } 19 | 20 | 21 | export function FlashcardDialog({ flashcard, index, updateFlashcard }: DialogProps) { 22 | return ( 23 | <> 24 | 25 | Edit flashcard 26 | 27 | Make changes to your flashcard here. Click save when you're done. 28 | 29 | 30 |
{ 31 | e.preventDefault(); 32 | const formData = new FormData(e.currentTarget); 33 | const updatedFlashcard = { 34 | question: formData.get('question') as string, 35 | answer: formData.get('answer') as string, 36 | }; 37 | updateFlashcard(index, updatedFlashcard); 38 | }}> 39 |
40 |
41 | 44 |