├── .env.example ├── .eslintrc.cjs ├── .gitignore ├── .prettierignore ├── .prettierrc.json ├── .vscode └── extensions.json ├── LICENSE ├── README.md ├── api_dockerfiles ├── .env ├── Dockerfile └── docker-compose.yml ├── index.html ├── package-lock.json ├── package.json ├── public └── favicon.ico ├── src ├── App.vue ├── api │ ├── middleware401.js │ ├── middlewareCSRF.js │ └── useAPI.js ├── assets │ ├── base.css │ └── logo.svg ├── helpers │ └── handleErrors.js ├── layouts │ ├── authLayout.vue │ └── defaultLayout.vue ├── main.js ├── router │ ├── index.js │ └── middleware │ │ └── auth-middleware.js ├── stores │ ├── auth.js │ └── user.js └── views │ ├── AboutView.vue │ ├── HomeView.vue │ └── auth │ ├── Forgot.vue │ ├── Login.vue │ └── Register.vue └── vite.config.js /.env.example: -------------------------------------------------------------------------------- 1 | API_HOST=http://localhost:8000 2 | API_PATH=/api 3 | -------------------------------------------------------------------------------- /.eslintrc.cjs: -------------------------------------------------------------------------------- 1 | /* eslint-env node */ 2 | require("@rushstack/eslint-patch/modern-module-resolution"); 3 | 4 | module.exports = { 5 | "root": true, 6 | "extends": [ 7 | "plugin:vue/vue3-essential", 8 | "eslint:recommended", 9 | "@vue/eslint-config-prettier" 10 | ], 11 | "env": { 12 | "vue/setup-compiler-macros": true 13 | }, 14 | rules: { 15 | "vue/multi-word-component-names": "off" 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | pnpm-debug.log* 8 | lerna-debug.log* 9 | 10 | node_modules 11 | 12 | .DS_Store 13 | dist 14 | dist-ssr 15 | coverage 16 | *.local 17 | 18 | /cypress/videos/ 19 | /cypress/screenshots/ 20 | 21 | # Editor directories and files 22 | .vscode/* 23 | !.vscode/extensions.json 24 | .idea 25 | *.suo 26 | *.ntvs* 27 | *.njsproj 28 | *.sln 29 | *.sw? 30 | 31 | # System files 32 | /.env 33 | .DS_Store 34 | .directory 35 | 36 | # Cache &misc files 37 | cache 38 | *.test 39 | *.prof 40 | *.swp 41 | *.swo 42 | *~ 43 | # Optional npm cache directory 44 | .npm 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | ## Docker 49 | *.override.yml 50 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | # Ignore everything: 2 | /* 3 | # Except my src app ( but only .js and .vue files, ignore .ts files): 4 | !src/ 5 | !src/**/*.vue 6 | !src/**/*.js 7 | 8 | src/**/*.spec.js 9 | src/**/*.ts -------------------------------------------------------------------------------- /.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "useTabs": true, 3 | "tabWidth": 2, 4 | "semi": false, 5 | "printWidth": 85, 6 | "singleQuote": true, 7 | "trailingComma": "es5", 8 | "bracketSpacing": true, 9 | "bracketSameLine": true, 10 | "arrowParens": "avoid", 11 | "htmlWhitespaceSensitivity": "strict" 12 | } -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "Vue.volar", 4 | "Vue.vscode-typescript-vue-plugin", 5 | "sdras.vue-vscode-snippets" 6 | ] 7 | } 8 | -------------------------------------------------------------------------------- /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 | # Laravel Breeze - Vue 3 Edition 🏝️ 2 | 3 | This repository is an implementation of the Laravel Breeze application / authentication starter kit frontend in **Vue.js v3** (*vite* powered + *pinia* + *vue-router*). All of the authentication boilerplate is already written for you - thanks to Laravel Sanctum, it allows you to quickly begin pairing an amazing Vue 3 frontend app with a powerful Laravel backend. 4 | 5 | This repo has: 6 | - Persistent state logic using localStorage API automatically (this is done within `pinia` stores). 7 | - Two middlewares: 8 | - One for `axios`: to deal with 401 permission denied case. 9 | - One for `vue-router`: to manage innacessibile routes if user is not logged in and viceversa. 10 | - Regarding CSS concerns this is less opinionated possible solution I found (only the minimum vanilla CSS but no third part libraries), so you can start from here and apply your favorite css framework/library if you like. 11 | 12 | ![vue3-laravel-api-img](https://user-images.githubusercontent.com/22715417/161379302-780a3224-e121-4644-a017-8faf3b45d950.png) 13 | 14 | PS: It is still working progress but following the MVP philosophy it works fine as a good starting kit (I still need to test the `/forgot-password` feature but the rest it's fine). 15 | 16 | ## Installation 17 | 18 | ### Laravel API endpoint 19 | 20 | This frontend app *needs an API service with Laravel 9* already in place in order to comunicate with the backend aspects. 21 | To make up for this lack I prepared some dockerfiles to launch the API environment in case you don't have it, this are for development only! 22 | 23 | If you want to use them simply go to the dockerfiles directory 24 | ```bash 25 | cd api_dockerfiles 26 | ``` 27 | And launch 28 | ```bash 29 | docker-compose up --build 30 | ``` 31 | 32 | Give it some time! - it will build the image, then launch a mysql container and only after mysql pass the healthcheck it will launch the actual Laravel container. 33 | 34 | You can tell that it's done by visiting `localhost:8000`, you should see the version of the Laravel app running. 35 | 36 | ### Frontend App 37 | 38 | Clone this repository and copy the .env.example: 39 | ```bash 40 | cp .env.example .env 41 | ``` 42 | Install the dependencies: 43 | ```bash 44 | npm install 45 | ``` 46 | Run the application with: 47 | ``` 48 | npm run dev 49 | ``` 50 | 51 | You should see the application at `localhost:3000`. 52 | 53 | ## Documentation: 54 | 55 | ### Axios Hook 56 | 57 | The auth store of this app contains a custom `useApi` hook designed to deal with the 2 different endpoints for the Laravel app, the one that points to the actual `/api` path, and the one that points to the login routes (e.g. `/login`, `/logout` etc...). By using this hook you don't have to worry to much about it: 58 | 59 | ```javascript 60 | import { useApi } from '@/api/useAPI.js' 61 | 62 | /** 63 | * You first create an instance using the hook function 64 | * if you need to use the `/api` endpoint you call the hook without params. Otherwise pass the 'web' argument 65 | */ 66 | 67 | const api = useApi() 68 | await api.post('/user') // will call `hostname/api/user` 69 | 70 | const web = useApi('web') 71 | await web.post('/login', { user, email }) // will call `hostname/login` 72 | ``` 73 | 74 | 75 | 76 | --- 77 | 78 | ## Recommended IDE Setup 79 | 80 | [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin). 81 | 82 | ### Compile and Minify for Production 83 | 84 | ```sh 85 | npm run build 86 | ``` 87 | 88 | ### Lint with [ESLint](https://eslint.org/) 89 | 90 | ```sh 91 | npm run lint 92 | ``` 93 | -------------------------------------------------------------------------------- /api_dockerfiles/.env: -------------------------------------------------------------------------------- 1 | APP_NAME=Laravel 2 | APP_ENV=local 3 | APP_KEY=base64:ZZjVSPBsdDrUueK5ZrTekdc3Ak7dUyM+XYTdsJAhpfE= 4 | APP_DEBUG=true 5 | APP_URL=http://localhost 6 | FRONTEND_URL=http://localhost:3000 7 | 8 | LOG_CHANNEL=stack 9 | LOG_LEVEL=debug 10 | 11 | DOCKER_IMAGE_NAME=ia_api_laravel9 12 | 13 | DB_CONNECTION=mysql 14 | DB_HOST=laravel9_database 15 | DB_PORT=3306 16 | DB_DATABASE=laravel 17 | DB_USERNAME=user 18 | DB_PASSWORD=pass 19 | 20 | BROADCAST_DRIVER=log 21 | CACHE_DRIVER=file 22 | FILESYSTEM_DRIVER=local 23 | QUEUE_CONNECTION=sync 24 | SESSION_DRIVER=file 25 | SESSION_LIFETIME=120 26 | 27 | MEMCACHED_HOST=127.0.0.1 28 | 29 | REDIS_HOST=127.0.0.1 30 | REDIS_PASSWORD=null 31 | REDIS_PORT=6379 32 | 33 | MAIL_MAILER=smtp 34 | MAIL_HOST=mailhog 35 | MAIL_PORT=1025 36 | MAIL_USERNAME=null 37 | MAIL_PASSWORD=null 38 | MAIL_ENCRYPTION=null 39 | MAIL_FROM_ADDRESS=null 40 | MAIL_FROM_NAME="${APP_NAME}" 41 | 42 | AWS_ACCESS_KEY_ID= 43 | AWS_SECRET_ACCESS_KEY= 44 | AWS_DEFAULT_REGION=us-east-1 45 | AWS_BUCKET= 46 | AWS_USE_PATH_STYLE_ENDPOINT=false 47 | 48 | PUSHER_APP_ID= 49 | PUSHER_APP_KEY= 50 | PUSHER_APP_SECRET= 51 | PUSHER_APP_CLUSTER=mt1 52 | 53 | MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}" 54 | MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}" 55 | -------------------------------------------------------------------------------- /api_dockerfiles/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM php:8.1-fpm 2 | 3 | RUN apt-get update -y \ 4 | && apt-get install -y libmcrypt-dev openssl openssh-client git zip unzip \ 5 | && apt-get clean \ 6 | && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* 7 | 8 | # Fixed version of composer for php 8.1 9 | COPY --from=composer:2.4.3 /usr/bin/composer /usr/bin/composer 10 | # RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer 11 | 12 | RUN pecl install mcrypt-1.0.5 13 | RUN docker-php-ext-enable mcrypt 14 | RUN docker-php-ext-install mysqli pdo_mysql 15 | 16 | ARG working_dir=/var/www/laravel-app/ 17 | RUN useradd --uid 1000 --user-group -ms /bin/bash www 18 | #RUN mkdir $working_dir && chown -R www:www $working_dir 19 | 20 | WORKDIR /tmp 21 | ADD https://github.com/laravel/laravel/archive/refs/tags/v9.0.0.tar.gz . 22 | RUN tar -xzvf v9.0.0.tar.gz && mv laravel-9.0.0 $working_dir 23 | 24 | RUN chown -R www:www $working_dir 25 | WORKDIR $working_dir 26 | USER www 27 | 28 | RUN rm -rf vendor composer.lock && \ 29 | composer config disable-tls true && \ 30 | composer install --no-dev --no-scripts --ignore-platform-reqs && \ 31 | composer dump-autoload && \ 32 | composer clear-cache && \ 33 | rm -rf ~/.composer/cache* 34 | 35 | RUN composer require laravel/breeze --dev 36 | 37 | RUN php artisan breeze:install api 38 | 39 | CMD php artisan migrate && php artisan serve --host=0.0.0.0 --port=8000 40 | -------------------------------------------------------------------------------- /api_dockerfiles/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "2.4" 2 | 3 | services: 4 | 5 | laravel9_database: 6 | image: mysql:8 7 | volumes: 8 | - database_api:/var/lib/mysql 9 | restart: unless-stopped 10 | healthcheck: 11 | test: mysqladmin -u${DB_USERNAME} -p${DB_PASSWORD} ping -h 127.0.0.1 12 | environment: 13 | MYSQL_ROOT_PASSWORD: ${DB_PASSWORD} 14 | MYSQL_DATABASE: ${DB_DATABASE} 15 | MYSQL_USER: ${DB_USERNAME} 16 | MYSQL_PASSWORD: ${DB_PASSWORD} 17 | 18 | laravel: 19 | build: . 20 | image: laravel9_api:from_scratch 21 | volumes: 22 | - ./.env:/var/www/laravel-app/.env 23 | depends_on: 24 | laravel9_database: 25 | condition: service_healthy 26 | restart: unless-stopped 27 | ports: 28 | - "8000:8000" 29 | 30 | volumes: 31 | database_api: 32 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Vite App 8 | 9 | 10 |
11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vue3-laravel-api", 3 | "version": "0.0.0", 4 | "scripts": { 5 | "dev": "vite", 6 | "build": "vite build", 7 | "preview": "vite preview --port 5050", 8 | "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore" 9 | }, 10 | "dependencies": { 11 | "axios": "^1.2.3", 12 | "pinia": "^2.0.29", 13 | "vue": "^3.2.45", 14 | "vue-router": "^4.1.6" 15 | }, 16 | "devDependencies": { 17 | "@rushstack/eslint-patch": "^1.2.0", 18 | "@vitejs/plugin-vue": "^4.0.0", 19 | "@vue/eslint-config-prettier": "^7.0.0", 20 | "eslint": "^8.32.0", 21 | "eslint-plugin-vue": "^9.9.0", 22 | "prettier": "^2.8.3", 23 | "sass": "^1.57.1", 24 | "vite": "^4.0.4" 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fsgreco/vue3-laravel-api/101df29bdcf1d637426cf29a844f90f8ebf3a9e5/public/favicon.ico -------------------------------------------------------------------------------- /src/App.vue: -------------------------------------------------------------------------------- 1 | 6 | 7 | 23 | 24 | 27 | -------------------------------------------------------------------------------- /src/api/middleware401.js: -------------------------------------------------------------------------------- 1 | import { useAuthStore } from '@/stores/auth.js' 2 | /** 3 | * Middleware - if user lost authentication (401) it gets kicked out 4 | * FROM https://youtu.be/BWNcuB3LQz8?t=1119 5 | */ 6 | const middleware401 = async error => { 7 | const { status } = error.request 8 | if (status === 401 || status === 419) { 9 | const auth = useAuthStore() 10 | setTimeout(async () => await auth.logout(), 3000) 11 | return Promise.reject({ 12 | name: 'Permission denied', 13 | message: 'You lost your credentials - will be redirected to login page.', 14 | }) 15 | } 16 | return Promise.reject(error) 17 | } 18 | 19 | export { middleware401 as default } 20 | -------------------------------------------------------------------------------- /src/api/middlewareCSRF.js: -------------------------------------------------------------------------------- 1 | import axios from 'axios' 2 | 3 | const getCookiesArray = () => document.cookie.split(';').reduce((cookieArray, cookie) => { 4 | let [key] = cookie.split('=') 5 | if (key) cookieArray.push(key.trim()) 6 | return cookieArray 7 | }, []) 8 | 9 | /** 10 | * If http method is `post | put | delete` and XSRF-TOKEN cookie is 11 | * not present, call '/sanctum/csrf-cookie' to set CSRF token, then 12 | * proceed with the initial request 13 | * @param {AxiosRequestConfig} axiosconfig 14 | * @returns {Promise} 15 | */ 16 | const middlewareCSFR = async axiosconfig => { 17 | let cookies = getCookiesArray() 18 | let isTokenMissing = !cookies.includes('XSRF-TOKEN') 19 | 20 | let methodsNeedCSRF = ['post', 'put', 'delete'] //other methods you want to add here 21 | let doesMethodRequireCSRF = methodsNeedCSRF.includes( axiosconfig.method ) 22 | 23 | if ( isTokenMissing && doesMethodRequireCSRF ) { 24 | // then first get the CSRF Token 25 | let pathCSFR = '/sanctum/csrf-cookie' 26 | let urlToCall = `${import.meta.env.API_HOST || 'http://localhost:8000'}${pathCSFR}` 27 | await axios.get(urlToCall, {withCredentials:true}) 28 | // then continue with the request 29 | return axiosconfig 30 | } 31 | 32 | return axiosconfig 33 | } 34 | 35 | export { middlewareCSFR as default } -------------------------------------------------------------------------------- /src/api/useAPI.js: -------------------------------------------------------------------------------- 1 | import axios from 'axios' 2 | import middleware401 from './middleware401' 3 | import middlewareCSRF from './middlewareCSRF' 4 | 5 | /** 6 | * Initialize Axios instance to call the API 7 | * @param {string} endpoint either 'web' or 'api' (default) 8 | * @returns {AxiosInstance} 9 | */ 10 | export const useApi = (endpoint = 'api') => { 11 | const { API_HOST, API_PATH } = import.meta.env 12 | 13 | let baseURL 14 | 15 | if (endpoint === 'api') { 16 | baseURL = API_HOST + API_PATH || 'http://localhost:8000/api' 17 | } else if (endpoint === 'web') { 18 | baseURL = API_HOST || 'http://localhost:8000' 19 | } 20 | 21 | const axiosInstance = axios.create({ 22 | baseURL, 23 | headers: { 'X-Requested-With': 'XMLHttpRequest' }, 24 | withCredentials: true, 25 | }) 26 | 27 | axiosInstance.interceptors.request.use( middlewareCSRF, err => Promise.reject(err)) 28 | 29 | axiosInstance.interceptors.response.use(resp => resp, middleware401) 30 | 31 | return axiosInstance 32 | } 33 | -------------------------------------------------------------------------------- /src/assets/base.css: -------------------------------------------------------------------------------- 1 | /* color palette from */ 2 | :root { 3 | --vt-c-white: whitesmoke; 4 | --vt-c-white-soft: #f8f8f8; 5 | --vt-c-white-mute: #f2f2f2; 6 | 7 | --vt-c-black: #181818; 8 | --vt-c-black-soft: #222222; 9 | --vt-c-black-mute: #282828; 10 | 11 | --vt-c-indigo: #2c3e50; 12 | 13 | --vt-c-divider-light-1: rgba(60, 60, 60, 0.29); 14 | --vt-c-divider-light-2: rgba(60, 60, 60, 0.12); 15 | --vt-c-divider-dark-1: rgba(84, 84, 84, 0.65); 16 | --vt-c-divider-dark-2: rgba(84, 84, 84, 0.48); 17 | 18 | --vt-c-text-light-1: var(--vt-c-indigo); 19 | --vt-c-text-light-2: rgba(60, 60, 60, 0.66); 20 | --vt-c-text-dark-1: var(--vt-c-white); 21 | --vt-c-text-dark-2: rgba(235, 235, 235, 0.64); 22 | 23 | --bkgr-gradient-1: linear-gradient( 24 | 57deg, 25 | rgba(140, 83, 179, 1) 0%, 26 | rgba(255, 83, 83, 1) 50%, 27 | rgba(251, 190, 104, 1) 100% 28 | ); 29 | --bkrg-gradient-vue: linear-gradient(315deg,#42d392 25%,#647eff); 30 | } 31 | 32 | /* semantic color variables for this project */ 33 | :root { 34 | --color-background: var(--vt-c-white); 35 | --color-background-soft: var(--vt-c-white-soft); 36 | --color-background-mute: var(--vt-c-white-mute); 37 | 38 | --color-border: var(--vt-c-divider-light-2); 39 | --color-border-hover: var(--vt-c-divider-light-1); 40 | 41 | --color-heading: var(--vt-c-text-light-1); 42 | --color-text: var(--vt-c-text-light-1); 43 | 44 | --section-gap: 160px; 45 | } 46 | 47 | @media (prefers-color-scheme: dark) { 48 | :root { 49 | --color-background: var(--vt-c-black); 50 | --color-background-soft: var(--vt-c-black-soft); 51 | --color-background-mute: var(--vt-c-black-mute); 52 | 53 | --color-border: var(--vt-c-divider-dark-2); 54 | --color-border-hover: var(--vt-c-divider-dark-1); 55 | 56 | --color-heading: var(--vt-c-text-dark-1); 57 | --color-text: var(--vt-c-text-dark-2); 58 | } 59 | } 60 | 61 | *, 62 | *::before, 63 | *::after { 64 | box-sizing: border-box; 65 | margin: 0; 66 | font-weight: normal; 67 | } 68 | 69 | body { 70 | min-height: 100vh; 71 | color: var(--color-text); 72 | background: var(--color-background); 73 | transition: color 0.5s, background-color 0.5s; 74 | line-height: 1.6; 75 | font-family: Inter, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, 76 | Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; 77 | font-size: 15px; 78 | text-rendering: optimizeLegibility; 79 | -webkit-font-smoothing: antialiased; 80 | -moz-osx-font-smoothing: grayscale; 81 | } 82 | -------------------------------------------------------------------------------- /src/assets/logo.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/helpers/handleErrors.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Rudimentary hook to handle errors from axios using alert. Do not use alert in production. 3 | * This hook is meant to be used along with some toast modal 4 | * It distinguish between error answers (http 400~599); network errors (if in the request) o other kind of errors. 5 | * @param {object} err The error object 6 | */ 7 | export function useHandleAxiosError(err) { 8 | if (err.response) { 9 | alert(`${err.message} -- ${err.response.data?.message} `) 10 | } else if (err.request) { 11 | alert(`${err.message} - Status ${err.request.status}`) 12 | } else { 13 | alert(`Unexpected Error -- ${err.message}`) 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /src/layouts/authLayout.vue: -------------------------------------------------------------------------------- 1 | 8 | 9 | 53 | -------------------------------------------------------------------------------- /src/layouts/defaultLayout.vue: -------------------------------------------------------------------------------- 1 | 23 | 24 | 33 | 34 | 93 | -------------------------------------------------------------------------------- /src/main.js: -------------------------------------------------------------------------------- 1 | import { createApp } from 'vue' 2 | import { createPinia } from 'pinia' 3 | 4 | import App from './App.vue' 5 | import router from './router' 6 | 7 | const app = createApp(App) 8 | 9 | app.use(createPinia()) 10 | app.use(router) 11 | 12 | app.mount('#app') 13 | -------------------------------------------------------------------------------- /src/router/index.js: -------------------------------------------------------------------------------- 1 | import { createRouter, createWebHistory } from 'vue-router' 2 | import authMiddleware from './middleware/auth-middleware' 3 | 4 | import HomeView from '../views/HomeView.vue' 5 | 6 | import Login from '@/views/auth/Login.vue' 7 | import Register from '@/views/auth/Register.vue' 8 | import Forgot from '@/views/auth/Forgot.vue' 9 | 10 | const router = createRouter({ 11 | history: createWebHistory(import.meta.env.BASE_URL), 12 | routes: [ 13 | { 14 | path: '/', 15 | name: 'home', 16 | component: HomeView, 17 | }, 18 | { 19 | path: '/about', 20 | name: 'about', 21 | component: () => import('../views/AboutView.vue'), 22 | }, 23 | // AUTH ROUTES 24 | { name: 'login', path: '/login', component: Login, meta: { layout: 'auth' } }, 25 | { 26 | name: 'register', 27 | path: '/register', 28 | component: Register, 29 | meta: { layout: 'auth' }, 30 | }, 31 | { 32 | name: 'forgot-password', 33 | path: '/forgot-password', 34 | component: Forgot, 35 | meta: { layout: 'auth' }, 36 | }, 37 | ], 38 | }) 39 | 40 | router.beforeEach(authMiddleware) 41 | 42 | export default router 43 | -------------------------------------------------------------------------------- /src/router/middleware/auth-middleware.js: -------------------------------------------------------------------------------- 1 | import { useAuthStore } from '@/stores/auth.js' 2 | 3 | export default (to, from, next) => { 4 | const auth = useAuthStore() 5 | 6 | let exceptionalRoutes = ['login', 'register', 'forgot-password'] 7 | let isGoingExceptionalRoutes = exceptionalRoutes.includes(to.name) 8 | 9 | /** 10 | * IF THE USER IS NOT LOGGED IN 11 | */ 12 | if (!auth.isLoggedIn) { 13 | if (isGoingExceptionalRoutes) { 14 | next() // The user is not logged in but it's going to exceptional routes ? fine 15 | return 16 | } else { 17 | next({ name: 'login' }) 18 | return 19 | } // other routes than exceptional paths => /login 20 | } 21 | 22 | /** 23 | * IF THE USER IS LOGGED IN 24 | */ 25 | if (auth.isLoggedIn && isGoingExceptionalRoutes) { 26 | next({ name: 'home', query: { 'redirect-reason': 'already logged' } }) 27 | } else { 28 | next() 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/stores/auth.js: -------------------------------------------------------------------------------- 1 | import { defineStore } from 'pinia' 2 | // import router from '@/router' 3 | import { useRouter } from 'vue-router' 4 | import { useUserStore } from '@/stores/user.js' 5 | import { useApi } from '@/api/useAPI' 6 | const web = useApi('web') 7 | 8 | export const useAuthStore = defineStore({ 9 | id: 'auth', 10 | 11 | state: () => 12 | JSON.parse(localStorage.getItem('AUTH_STATE')) ?? { 13 | email: null, 14 | isLoggedIn: false, 15 | }, 16 | 17 | actions: { 18 | updateState(payload) { 19 | let newUserState = { ...this.$state, ...payload } 20 | localStorage.removeItem('AUTH_STATE') 21 | localStorage.setItem('AUTH_STATE', JSON.stringify(newUserState)) 22 | this.$reset() 23 | }, 24 | async login({ email, password }) { 25 | const user = useUserStore() 26 | try { 27 | await web.post('/login', { email, password }) 28 | this.updateState({ email, isLoggedIn: true }) 29 | await user.storeInfo() 30 | } catch (error) { 31 | console.log('Error at login: ', error.message) 32 | throw error 33 | } 34 | }, 35 | async register(props) { 36 | const user = useUserStore() 37 | try { 38 | await web.post('/register', props) 39 | this.updateState({ email: props.email, isLoggedIn: true }) 40 | await user.storeInfo() 41 | } catch (error) { 42 | console.log('Error at register: ', error.message) 43 | throw error 44 | } 45 | }, 46 | async forgotPassword({ email }) { 47 | try { 48 | await web.post('/forgot-password', { email }) 49 | } catch (error) { 50 | console.log('ERROR WITH FORGOT-PASSWORD ENDPOINT: ', error.message) 51 | throw error 52 | } 53 | }, 54 | 55 | async logout() { 56 | const user = useUserStore() 57 | const router = useRouter() 58 | localStorage.clear() // always clean localStorage before reset the state 59 | this.$reset() 60 | user.$reset() 61 | 62 | try { 63 | await web.post('/logout') 64 | await router.push({ name: 'login' }) 65 | } catch (error) { 66 | window.location.pathname = '/login' 67 | } 68 | }, 69 | }, 70 | }) 71 | -------------------------------------------------------------------------------- /src/stores/user.js: -------------------------------------------------------------------------------- 1 | import { defineStore } from 'pinia' 2 | import { useApi } from '@/api/useAPI.js' 3 | 4 | const api = useApi() 5 | 6 | export const useUserStore = defineStore({ 7 | id: 'user', 8 | 9 | state: () => JSON.parse(localStorage.getItem('USER_INFO')) ?? { 10 | id: null, 11 | name: 'guest', 12 | email: null, 13 | }, 14 | 15 | actions: { 16 | updateState(payload) { 17 | let newUserState = { ...this.state, ...payload } 18 | localStorage.removeItem('USER_INFO') 19 | localStorage.setItem('USER_INFO', JSON.stringify(newUserState)) 20 | this.$reset() 21 | }, 22 | 23 | async storeInfo() { 24 | let { data: userInfo } = await api.get('/user') 25 | localStorage.setItem('USER_INFO', JSON.stringify(userInfo)) 26 | this.$reset() 27 | }, 28 | }, 29 | }) 30 | -------------------------------------------------------------------------------- /src/views/AboutView.vue: -------------------------------------------------------------------------------- 1 | 16 | -------------------------------------------------------------------------------- /src/views/HomeView.vue: -------------------------------------------------------------------------------- 1 | 8 | 9 | 13 | -------------------------------------------------------------------------------- /src/views/auth/Forgot.vue: -------------------------------------------------------------------------------- 1 | 14 | 15 | 22 | 23 | 30 | -------------------------------------------------------------------------------- /src/views/auth/Login.vue: -------------------------------------------------------------------------------- 1 | 26 | 27 | 49 | 50 | 57 | -------------------------------------------------------------------------------- /src/views/auth/Register.vue: -------------------------------------------------------------------------------- 1 | 24 | 25 | 45 | 46 | 53 | -------------------------------------------------------------------------------- /vite.config.js: -------------------------------------------------------------------------------- 1 | import { fileURLToPath, URL } from 'url' 2 | 3 | import { defineConfig } from 'vite' 4 | import vue from '@vitejs/plugin-vue' 5 | 6 | // https://vitejs.dev/config/ 7 | export default defineConfig({ 8 | server: { port: 3000 }, // keep in sync with the FRONTEND_URL env var of Laravel docker container 9 | plugins: [vue()], 10 | resolve: { 11 | alias: { 12 | '@': fileURLToPath(new URL('./src', import.meta.url)) 13 | } 14 | } 15 | }) 16 | --------------------------------------------------------------------------------