Austin/reader
1
0
Fork 0
mirror of https://github.com/intergalacticalvariable/reader.git synced 2024-11-15 19:22:20 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: rename url2text to reader

Browse Source
This commit is contained in:
Han Xiao 2024-04-13 11:42:15 -07:00
parent 33d7cfc41c
commit 8e241c7f5a
9 changed files with 216 additions and 1128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -1,2 +1,4 @@
node_modules/ node_modules/
.DS_Store .DS_Store
.vscode
.cache

10
.vscode/exensions.json vendored
View File

@ -1,10 +0,0 @@
{
"recommendations": [
"editorconfig.editorconfig",
"octref.vetur",
"redhat.vscode-yaml",
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"streetsidesoftware.code-spell-checker"
]
}

60
.vscode/launch.json vendored
View File

@ -1,60 +0,0 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Debug Fullstack: attach",
"request": "attach",
"cwd": "${workspaceFolder}/backend/functions",
"skipFiles": [
"<node_internals>/**"
],
"type": "node",
"preLaunchTask": "Fullstack:debug"
},
{
"name": "Debug Fullstack: attach: with proxy",
"request": "attach",
"cwd": "${workspaceFolder}/backend/functions",
"skipFiles": [
"<node_internals>/**"
],
"type": "node",
"preLaunchTask": "Fullstack:debug:with-proxy"
},
{
"name": "Attach",
"port": 9229,
"request": "attach",
"skipFiles": [
"<node_internals>/**"
],
"type": "node"
},
{
"name": "Attach by Process ID",
"processId": "${command:PickProcess}",
"request": "attach",
"skipFiles": [
"<node_internals>/**"
],
"type": "node"
},
{
"name": "Debug Fullstack",
"request": "launch",
"runtimeArgs": [
"emulators:start",
"--import=../.firebase-emu",
"--export-on-exit=../.firebase-emu",
],
"cwd": "${workspaceFolder}/backend/functions",
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/firebase",
"skipFiles": [
"<node_internals>/**"
],
"type": "node",
"preLaunchTask": "Fullstack:prepare",
"killBehavior": "polite"
},
]
}

105
.vscode/settings.json vendored
View File

@ -1,105 +0,0 @@
{
"editor.wordWrap": "on",
"editor.wordWrapColumn": 120,
"files.trimTrailingWhitespace": true,
"files.trimFinalNewlines": true,
"[javascript]": {
"editor.defaultFormatter": "vscode.typescript-language-features"
},
"[vue]": {
"editor.defaultFormatter": "Vue.volar"
},
"[jsonc]": {
"editor.defaultFormatter": "vscode.json-language-features"
},
"[typescript]": {
"editor.defaultFormatter": "vscode.typescript-language-features"
},
"[json]": {
"editor.defaultFormatter": "vscode.json-language-features"
},
"[yaml]": {
"editor.defaultFormatter": "redhat.vscode-yaml"
},
"[markdown]": {
"files.trimTrailingWhitespace": false
},
"typescript.tsdk": "node_modules/typescript/lib",
"vetur.format.defaultFormatter.ts": "vscode-typescript",
"vetur.format.defaultFormatter.js": "vscode-typescript",
"typescript.preferences.quoteStyle": "single",
"typescript.format.semicolons": "insert",
"typescript.preferences.importModuleSpecifier": "project-relative",
"typescript.locale": "en",
"cSpell.enabled": true,
"cSpell.words": [
"Apiextensions",
"apihubble",
"auths",
"AUTOCASTABLE",
"Autocasting",
"backchannel",
"bodyparser",
"bson",
"BUILDKIT",
"buildx",
"castable",
"cmdl",
"Commandline",
"conpty",
"cpid",
"deferreds",
"DEVBOT",
"dockerhub",
"entrypoint",
"ENVIROMENT",
"finetuner",
"fpath",
"fswalk",
"Grafana",
"Hasher",
"istio",
"jina",
"jinahub",
"jinameta",
"Knative",
"kourier",
"kube",
"kubectl",
"Kubernetes",
"kwargs",
"letsencrypt",
"liveconfigs",
"LOGNAME",
"metas",
"Mgmt",
"middlewares",
"minikube",
"minio",
"ndjson",
"nodelib",
"oidc",
"openapi",
"paramtypes",
"penv",
"pino",
"prebuild",
"quickstart",
"reinit",
"sslip",
"subval",
"Succ",
"timedout",
"TOTP",
"tsbuildinfo",
"tsyringe",
"typeclass",
"upsert",
"upserted",
"userinfo",
"Vecs",
"vectorize",
"WECHAT",
"WXPAY"
],
}

156
.vscode/tasks.json vendored
View File

@ -1,156 +0,0 @@
{
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "build",
"group": "build",
"options": {
"cwd": "${workspaceFolder}/backend/functions"
},
"problemMatcher": [],
"label": "Backend:rebuild",
"detail": "Backend:rebuild"
},
{
"type": "npm",
"script": "emu:reset",
"group": "build",
"options": {
"cwd": "${workspaceFolder}/backend/functions"
},
"problemMatcher": [],
"label": "Backend:reset-emulator",
"detail": "Backend:reset-emulator"
},
{
"type": "typescript",
"options": {
"cwd": "${workspaceFolder}/backend/functions"
},
"tsconfig": "backend/functions/tsconfig.json",
"option": "watch",
"isBackground": true,
"problemMatcher": [
"$tsc-watch"
],
"group": "build",
"label": "Backend:build:watch"
},
{
"type": "npm",
"script": "emu:debug",
"group": "none",
"options": {
"cwd": "${workspaceFolder}/backend/functions"
},
"problemMatcher": [
{
"base": "$tsc",
"background": {
"activeOnStart": false,
"beginsPattern": "shutdown requested|Starting emulators",
"endsPattern": "Debugger listening"
}
}
],
"label": "Backend:start-emulator-debug",
"detail": "Backend:start-emulator-debug",
"dependsOn": [
"Backend:build:watch"
],
"isBackground": true,
},
{
"type": "npm",
"script": "dev",
"options": {
"cwd": "${workspaceFolder}/webapp",
},
"group": "build",
"label": "Frontend:start:dev",
"detail": "Frontend:start:dev",
"isBackground": true,
"problemMatcher": {
"base": "$vite",
"background": {
"activeOnStart": true,
"endsPattern": "OK",
"beginsPattern": "vite"
}
},
},
{
"type": "npm",
"script": "dev",
"options": {
"cwd": "${workspaceFolder}/webapp",
"env": {
"FIREBASE_EMULATE": "true",
}
},
"group": "build",
"label": "Frontend:start:emu",
"detail": "Frontend:start:emu",
"isBackground": true,
"problemMatcher": {
"base": "$vite",
"background": {
"activeOnStart": true,
"endsPattern": "OK",
"beginsPattern": "vite"
}
},
},
{
"type": "npm",
"script": "emu:debug2",
"group": "none",
"options": {
"cwd": "${workspaceFolder}/backend/functions",
"env": {
"https_proxy": "http://127.0.0.1:7890",
"http_proxy": "http://127.0.0.1:7890",
"all_proxy": "socks5://127.0.0.1:7890"
}
},
"problemMatcher": [
{
"base": "$tsc",
"background": {
"activeOnStart": false,
"beginsPattern": "shutdown requested|Starting emulators",
"endsPattern": "Debugger listening"
}
}
],
"label": "Backend:start-emulator-debug:with-proxy",
"detail": "Backend:start-emulator-debug:with-proxy",
"dependsOn": [
"Backend:build:watch"
],
"isBackground": true,
},
{
"label": "Fullstack:prepare",
"dependsOn": [
"Frontend:start:emu",
"Backend:build:watch",
],
},
{
"label": "Fullstack:debug",
"dependsOn": [
// "Frontend:start:emu",
"Backend:start-emulator-debug",
],
},
{
"label": "Fullstack:debug:with-proxy",
"dependsOn": [
"Frontend:start:emu",
"Backend:start-emulator-debug:with-proxy",
],
}
]
}

854
LICENSE
View File

@ -1,661 +1,193 @@
GNU AFFERO GENERAL PUBLIC LICENSE Copyright 2020-2024 Jina AI Limited. All rights reserved.
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Apache License
Everyone is permitted to copy and distribute verbatim copies Version 2.0, January 2004
of this license document, but changing it is not allowed. http://www.apache.org/licenses/
Preamble TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
The GNU Affero General Public License is a free, copyleft license for 1. Definitions.
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software. "License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast, "Licensor" shall mean the copyright owner or entity authorized by
our General Public Licenses are intended to guarantee your freedom to the copyright owner that is granting the License.
share and change all versions of a program--to make sure it remains free
software for all its users. "Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
When we speak of free software, we are referring to freedom, not control with that entity. For the purposes of this definition,
price. Our General Public Licenses are designed to make sure that you "control" means (i) the power, direct or indirect, to cause the
have the freedom to distribute copies of free software (and charge for direction or management of such entity, whether by contract or
them if you wish), that you receive source code or can get it if you otherwise, or (ii) ownership of fifty percent (50%) or more of the
want it, that you can change the software or use pieces of it in new outstanding shares, or (iii) beneficial ownership of such entity.
free programs, and that you know you can do these things.
"You" (or "Your") shall mean an individual or Legal Entity
Developers that use our General Public Licenses protect your rights exercising permissions granted by this License.
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute "Source" form shall mean the preferred form for making modifications,
and/or modify the software. including but not limited to software source code, documentation
source, and configuration files.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they "Object" form shall mean any form resulting from mechanical
receive widespread use, become available for other developers to transformation or translation of a Source form, including but
incorporate. Many developers of free software are heartened and not limited to compiled object code, generated documentation,
encouraged by the resulting cooperation. However, in the case of and conversions to other media types.
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and "Work" shall mean the work of authorship, whether in Source or
letting the public access it on a server without ever releasing its Object form, made available under the License, as indicated by a
source code to the public. copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available "Derivative Works" shall mean any work, whether in Source or Object
to the community. It requires the operator of a network server to form, that is based on (or derived from) the Work and for which the
provide the source code of the modified version running there to the editorial revisions, annotations, elaborations, or other modifications
users of that server. Therefore, public use of a modified version, on represent, as a whole, an original work of authorship. For the purposes
a publicly accessible server, gives the public access to the source of this License, Derivative Works shall not include works that remain
code of the modified version. separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is "Contribution" shall mean any work of authorship, including
a different license, not a version of the Affero GPL, but Affero has the original version of the Work and any modifications or additions
released a new version of the Affero GPL which permits relicensing under to that Work or Derivative Works thereof, that is intentionally
this license. submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
The precise terms and conditions for copying, distribution and the copyright owner. For the purposes of this definition, "submitted"
modification follow. means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
TERMS AND CONDITIONS communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
0. Definitions. Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
"This License" refers to version 3 of the GNU Affero General Public License. designated in writing by the copyright owner as "Not a Contribution."
"Copyright" also means copyright-like laws that apply to other kinds of "Contributor" shall mean Licensor and any individual or Legal Entity
works, such as semiconductor masks. on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and 2. Grant of Copyright License. Subject to the terms and conditions of
"recipients" may be individuals or organizations. this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
To "modify" a work means to copy from or adapt all or part of the work copyright license to reproduce, prepare Derivative Works of,
in a fashion requiring copyright permission, other than the making of an publicly display, publicly perform, sublicense, and distribute the
exact copy. The resulting work is called a "modified version" of the Work and such Derivative Works in Source or Object form.
earlier work or a work "based on" the earlier work.
3. Grant of Patent License. Subject to the terms and conditions of
A "covered work" means either the unmodified Program or a work based this License, each Contributor hereby grants to You a perpetual,
on the Program. worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
To "propagate" a work means to do anything with it that, without use, offer to sell, sell, import, and otherwise transfer the Work,
permission, would make you directly or secondarily liable for where such license applies only to those patent claims licensable
infringement under applicable copyright law, except executing it on a by such Contributor that are necessarily infringed by their
computer or modifying a private copy. Propagation includes copying, Contribution(s) alone or by combination of their Contribution(s)
distribution (with or without modification), making available to the with the Work to which such Contribution(s) was submitted. If You
public, and in some countries other activities as well. institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
To "convey" a work means any kind of propagation that enables other or a Contribution incorporated within the Work constitutes direct
parties to make or receive copies. Mere interaction with a user through or contributory patent infringement, then any patent licenses
a computer network, with no transfer of a copy, is not conveying. granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible 4. Redistribution. You may reproduce and distribute copies of the
feature that (1) displays an appropriate copyright notice, and (2) Work or Derivative Works thereof in any medium, with or without
tells the user that there is no warranty for the work (except to the modifications, and in Source or Object form, provided that You
extent that warranties are provided), that licensees may convey the meet the following conditions:
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a (a) You must give any other recipients of the Work or
menu, a prominent item in the list meets this criterion. Derivative Works a copy of this License; and
1. Source Code. (b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source (c) You must retain, in the Source form of any Derivative Works
form of a work. that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
A "Standard Interface" means an interface that either is an official excluding those notices that do not pertain to any part of
standard defined by a recognized standards body, or, in the case of the Derivative Works; and
interfaces specified for a particular programming language, one that
is widely used among developers working in that language. (d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
The "System Libraries" of an executable work include anything, other include a readable copy of the attribution notices contained
than the work as a whole, that (a) is included in the normal form of within such NOTICE file, excluding those notices that do not
packaging a Major Component, but which is not part of that Major pertain to any part of the Derivative Works, in at least one
Component, and (b) serves only to enable use of the work with that of the following places: within a NOTICE text file distributed
Major Component, or to implement a Standard Interface for which an as part of the Derivative Works; within the Source form or
implementation is available to the public in source code form. A documentation, if provided along with the Derivative Works; or,
"Major Component", in this context, means a major essential component within a display generated by the Derivative Works, if and
(kernel, window system, and so on) of the specific operating system wherever such third-party notices normally appear. The contents
(if any) on which the executable work runs, or a compiler used to of the NOTICE file are for informational purposes only and
produce the work, or an object code interpreter used to run it. do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
The "Corresponding Source" for a work in object code form means all or as an addendum to the NOTICE text from the Work, provided
the source code needed to generate, install, and (for an executable that such additional attribution notices cannot be construed
work) run the object code and to modify the work, including scripts to as modifying the License.
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free You may add Your own copyright statement to Your modifications and
programs which are used unmodified in performing those activities but may provide additional or different license terms and conditions
which are not part of the work. For example, Corresponding Source for use, reproduction, or distribution of Your modifications, or
includes interface definition files associated with source files for for any such Derivative Works as a whole, provided Your use,
the work, and the source code for shared libraries and dynamically reproduction, and distribution of the Work otherwise complies with
linked subprograms that the work is specifically designed to require, the conditions stated in this License.
such as by intimate data communication or control flow between those
subprograms and other parts of the work. 5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
The Corresponding Source need not include anything that users by You to the Licensor shall be under the terms and conditions of
can regenerate automatically from other parts of the Corresponding this License, without any additional terms or conditions.
Source. Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
The Corresponding Source for a work in source code form is that with Licensor regarding such Contributions.
same work.
6. Trademarks. This License does not grant permission to use the trade
2. Basic Permissions. names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
All rights granted under this License are granted for the term of origin of the Work and reproducing the content of the NOTICE file.
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited 7. Disclaimer of Warranty. Unless required by applicable law or
permission to run the unmodified Program. The output from running a agreed to in writing, Licensor provides the Work (and each
covered work is covered by this License only if the output, given its Contributor provides its Contributions) on an "AS IS" BASIS,
content, constitutes a covered work. This License acknowledges your WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
rights of fair use or other equivalent, as provided by copyright law. implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
You may make, run and propagate covered works that you do not PARTICULAR PURPOSE. You are solely responsible for determining the
convey, without conditions so long as your license otherwise remains appropriateness of using or redistributing the Work and assume any
in force. You may convey covered works to others for the sole purpose risks associated with Your exercise of permissions under this License.
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with 8. Limitation of Liability. In no event and under no legal theory,
the terms of this License in conveying all material for which you do whether in tort (including negligence), contract, or otherwise,
not control copyright. Those thus making or running the covered works unless required by applicable law (such as deliberate and grossly
for you must do so exclusively on your behalf, under your direction negligent acts) or agreed to in writing, shall any Contributor be
and control, on terms that prohibit them from making any copies of liable to You for damages, including any direct, indirect, special,
your copyrighted material outside their relationship with you. incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Conveying under any other circumstances is permitted solely under Work (including but not limited to damages for loss of goodwill,
the conditions stated below. Sublicensing is not allowed; section 10 work stoppage, computer failure or malfunction, or any and all
makes it unnecessary. other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
9. Accepting Warranty or Additional Liability. While redistributing
No covered work shall be deemed part of an effective technological the Work or Derivative Works thereof, You may choose to offer,
measure under any applicable law fulfilling obligations under article and charge a fee for, acceptance of support, warranty, indemnity,
11 of the WIPO copyright treaty adopted on 20 December 1996, or or other liability obligations and/or rights consistent with this
similar laws prohibiting or restricting circumvention of such License. However, in accepting such obligations, You may act only
measures. on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
When you convey a covered work, you waive any legal power to forbid defend, and hold each Contributor harmless for any liability
circumvention of technological measures to the extent such circumvention incurred by, or claims asserted against, such Contributor by reason
is effected by exercising rights under this License with respect to of your accepting any such warranty or additional liability.
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's END OF TERMS AND CONDITIONS
users, your or third parties' legal rights to forbid circumvention of
technological measures. Copyright 2020-2021 Jina AI Limited
4. Conveying Verbatim Copies. Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may convey verbatim copies of the Program's source code as you You may obtain a copy of the License at
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice; http://www.apache.org/licenses/LICENSE-2.0
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code; Unless required by applicable law or agreed to in writing, software
keep intact all notices of the absence of any warranty; and give all distributed under the License is distributed on an "AS IS" BASIS,
recipients a copy of this License along with the Program. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
You may charge any price or no price for each copy that you convey, limitations under the License.
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.

118
README.md
View File

@ -1,112 +1,34 @@
# reader # Reader
## Development Guide Convert any URL to an LLM-friendly input with a simple prefix `https://r.jina.ai/`. Get improved output for your agent and RAG systems at no cost. Find more at https://jina.ai/reader.
### Prerequisite ## Usage
- Node v18 (The build fails for Node version >18)
- Yarn
- Firebase CLI (`npm install -g firebase-tools`)
### Installation To use the Reader, simply prepend `https://r.jina.ai/` to any URL. For example, to convert the URL `https://en.wikipedia.org/wiki/Artificial_intelligence` to an LLM-friendly input, use the following URL:
Clone the scenex repo by running the command:
```bash ```bash
git clone git@github.com:jina-ai/reader.git https://r.jina.ai/https://en.wikipedia.org/wiki/Artificial_intelligence
git submodule init
git submodule update
``` ```
After a successful clone, install the packages for backend and the webapp. ### Streaming
Use accept-header to control the streaming behavior:
```bash
curl -H "Accept: text/event-stream" https://r.jina.ai/https://en.m.wikipedia.org/wiki/Main_Page
```
## Install
You will need the following tools to run the project:
- Node v18 (The build fails for Node version >18)
- Firebase CLI (`npm install -g firebase-tools`)
For backend, go to the `backend/functions` directory and install the npm dependencies. For backend, go to the `backend/functions` directory and install the npm dependencies.
```bash ```bash
git clone git@github.com:jina-ai/reader.git
cd backend/functions cd backend/functions
npm install npm install
``` ```
For the frontend (webapp), go to the `webapp` directory and install the yarn dependencies.
```bash
cd webapp
yarn
```
### Configure
**Establish localhost connection:**
Once the packages are installed, go to the `App.vue` file inside the `webapp/src/` and uncomment the below code:
```js
connectFunctionsEmulator(functions, 'localhost', 5001);
```
### Run The Application Now
To run the backend server, inside the `backend/functions` dir run the below command:
```bash
npm run serve
```
To run the frontend app, inside the `webapp` dir run the below command:
```bash
yarn dev
```
### Known Errors
1. If you encounter 'npm ERR! /bin/sh: pkg-config: command not found' error in Mac, run the command `brew install pkg-config cairo libpng jpeg giflib pango librsvg`
## Best practices
### Directory structure
There are three folders:
1. `webapp` is the frontend project of `SceneX`, knowledge requirements:
- Vue 3
- Quasar
- ...
2. `backend` contains source code of backend logic, knowledge requirements:
- Nodejs
- Firebase
- ...
3. `scripts` folder includes custom scripts we might need during the development or for production, currently we have the following scripts:
- `translate` is responsible for translating and updating our i18n language files in frontend project.
### Best practices of frontend
1. **Quasar docs** is your `best friend`. Since the frontend project highly depends on framework `Quasar`. It is recommended to use the predefined classes and components and avoid defining your custom classes
2. **Double check** of the UI output in `Dark mode` and `Light mode`. Again, use predefined classes and props.
3. **Plugins in boot** folder: create corresponding file in `boot` folder and use them in `quasar.config.js`:
```js
module.exports = configure(function() {
return {
...
boot: [
'i18n',
'axios',
'firebase',
'addressbar-color',
'quasar-lang-pack'
],
...
}
})
```
### Best practices of backend
1. **Remember to deploy your functions** by running:
```bash
# deploy all functions
firebase deploy --only functions
# deploy a specific function
firebase deploy --only functions:{function name}
```

27
backend/functions/.vscode/launch.json vendored
View File

@ -1,27 +0,0 @@
{
// 使用 IntelliSense 了解相关属性。
// 悬停以查看现有属性的描述。
// 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Attach by Process ID",
"processId": "${command:PickProcess}",
"request": "attach",
"skipFiles": [
"<node_internals>/**"
],
"type": "node"
},
{
"name": "Attach",
"port": 9229,
"request": "attach",
"skipFiles": [
"<node_internals>/**"
],
"type": "node"
}
]
}

10
backend/functions/.vscode/settings.json vendored
View File

@ -1,10 +0,0 @@
{
"cSpell.words": [
"AIHTTP",
"Castable",
"civkit",
"Firestore",
"openai"
],
"typescript.tsdk": "node_modules/typescript/lib"
}