├── server ├── Procfile ├── static │ ├── file │ │ ├── github-privacy.pdf │ │ ├── heading-test.html │ │ ├── AA-README.html │ │ └── TypeScript入门学习总结.html │ └── testFiles │ │ ├── no-match-heading-test.md │ │ ├── heading-test.md │ │ └── TypeScript入门学习总结.md ├── create_index.py ├── requirements.txt ├── pdf_loader.py ├── custom_loader.py └── app.py ├── .gitattributes ├── client ├── src │ ├── vite-env.d.ts │ ├── utils │ │ ├── isDev.ts │ │ ├── isPdf.ts │ │ ├── eventEmitter.ts │ │ ├── fetch.ts │ │ ├── request.ts │ │ └── useOpenAiKey.ts │ ├── constants │ │ └── fileItem.ts │ ├── routes.tsx │ ├── context │ │ └── currentFile.ts │ ├── components │ │ ├── chatWindow │ │ │ ├── constants.ts │ │ │ ├── Loading.tsx │ │ │ ├── Message.tsx │ │ │ └── index.tsx │ │ ├── pageSpin │ │ │ └── index.tsx │ │ ├── htmlViewer │ │ │ └── index.tsx │ │ ├── fileCard │ │ │ └── index.tsx │ │ ├── settingsModal │ │ │ └── index.tsx │ │ ├── pdfViewer │ │ │ └── index.tsx │ │ ├── upload │ │ │ └── index.tsx │ │ └── sideMenu │ │ │ └── index.tsx │ ├── main.tsx │ ├── styles │ │ └── globals.scss │ ├── App.tsx │ ├── pages │ │ └── Home.tsx │ └── assets │ │ └── react.svg ├── public │ └── favicon.ico ├── .prettierrc ├── postcss.config.cjs ├── vite.config.ts ├── tsconfig.node.json ├── tailwind.config.js ├── tsconfig.json ├── .eslintrc.json ├── index.html └── package.json ├── vercel.json ├── .env.example ├── .github ├── ISSUE_TEMPLATE │ ├── config.yml │ └── bug_report.yml └── workflows │ └── issue.yml ├── docker ├── Dockerfile.server └── Dockerfile.client ├── docker-compose.yml ├── .gitignore ├── nginx.conf ├── Deployment.md ├── README.md └── LICENSE /server/Procfile: -------------------------------------------------------------------------------- 1 | web: gunicorn app:app -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | server/static/** linguist-detectable=false 2 | -------------------------------------------------------------------------------- /client/src/vite-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | -------------------------------------------------------------------------------- /client/src/utils/isDev.ts: -------------------------------------------------------------------------------- 1 | export const isDev = import.meta.env.DEV; 2 | -------------------------------------------------------------------------------- /vercel.json: -------------------------------------------------------------------------------- 1 | { 2 | "github": { 3 | "silent": true 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /client/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/3Alan/DocsMind/HEAD/client/public/favicon.ico -------------------------------------------------------------------------------- /client/src/utils/isPdf.ts: -------------------------------------------------------------------------------- 1 | export default function isPdf(ext: string) { 2 | return ext === '.pdf'; 3 | } 4 | -------------------------------------------------------------------------------- /server/static/file/github-privacy.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/3Alan/DocsMind/HEAD/server/static/file/github-privacy.pdf -------------------------------------------------------------------------------- /client/.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "printWidth": 100, 3 | "singleQuote": true, 4 | "tabWidth": 2, 5 | "trailingComma": "none" 6 | } 7 | -------------------------------------------------------------------------------- /client/postcss.config.cjs: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | plugins: { 3 | tailwindcss: {}, 4 | autoprefixer: {}, 5 | }, 6 | } 7 | -------------------------------------------------------------------------------- /client/src/constants/fileItem.ts: -------------------------------------------------------------------------------- 1 | export default interface FileItem { 2 | name: string; 3 | fullName: string; 4 | path: string; 5 | ext: string; 6 | } 7 | -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | # will replace https://api.openai.com/v1 2 | # OPENAI_PROXY="" 3 | 4 | # optional backend url for production frontend code 5 | # VITE_SERVICES_URL="http://localhost:8080" -------------------------------------------------------------------------------- /client/src/routes.tsx: -------------------------------------------------------------------------------- 1 | import Home from './pages/Home'; 2 | 3 | const routes = [ 4 | { 5 | path: '/', 6 | element: 7 | } 8 | ]; 9 | 10 | export default routes; 11 | -------------------------------------------------------------------------------- /client/src/context/currentFile.ts: -------------------------------------------------------------------------------- 1 | import { createContext } from 'react'; 2 | import FileItem from '../constants/fileItem'; 3 | 4 | export const CurrentFileContext = createContext(null); 5 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: 🚀 New feature proposal 4 | url: https://github.com/3Alan/DocsMind/discussions 5 | about: Request for new features. -------------------------------------------------------------------------------- /client/vite.config.ts: -------------------------------------------------------------------------------- 1 | import { defineConfig } from 'vite'; 2 | import react from '@vitejs/plugin-react'; 3 | 4 | // https://vitejs.dev/config/ 5 | export default defineConfig({ 6 | plugins: [react()] 7 | }); 8 | -------------------------------------------------------------------------------- /client/src/components/chatWindow/constants.ts: -------------------------------------------------------------------------------- 1 | import { ReactNode } from 'react'; 2 | 3 | export interface MessageItem { 4 | question?: string; 5 | reply?: ReactNode; 6 | cost?: number; 7 | sources?: any[]; 8 | error?: boolean; 9 | } 10 | -------------------------------------------------------------------------------- /client/tsconfig.node.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "composite": true, 4 | "module": "ESNext", 5 | "moduleResolution": "Node", 6 | "allowSyntheticDefaultImports": true 7 | }, 8 | "include": ["vite.config.ts"] 9 | } 10 | -------------------------------------------------------------------------------- /client/src/components/pageSpin/index.tsx: -------------------------------------------------------------------------------- 1 | import { Spin } from 'antd'; 2 | 3 | export default function PageSpin() { 4 | return ( 5 |
6 | 7 |
8 | ); 9 | } 10 | -------------------------------------------------------------------------------- /client/src/utils/eventEmitter.ts: -------------------------------------------------------------------------------- 1 | import mitt from 'mitt'; 2 | 3 | type Events = { 4 | scrollToPage: { pageNo: number; time: number }; 5 | cleanChat?: null; 6 | refreshFileList?: null; 7 | refreshSettings?: null; 8 | }; 9 | 10 | const eventEmitter = mitt(); 11 | 12 | export default eventEmitter; 13 | -------------------------------------------------------------------------------- /docker/Dockerfile.server: -------------------------------------------------------------------------------- 1 | FROM python:3.9-slim-buster 2 | 3 | WORKDIR /server 4 | 5 | COPY ./server/requirements.txt requirements.txt 6 | 7 | RUN pip3 install -r requirements.txt 8 | 9 | COPY ./server . 10 | COPY .env . 11 | 12 | EXPOSE 8080 13 | 14 | CMD ["flask", "run", "--host", "0.0.0.0", "--port", "8080"] -------------------------------------------------------------------------------- /client/tailwind.config.js: -------------------------------------------------------------------------------- 1 | /** @type {import('tailwindcss').Config} */ 2 | export default { 3 | content: ['./src/**/*.{js,ts,jsx,tsx}'], 4 | theme: { 5 | extend: { 6 | colors: { 7 | 'card-blue': '#e6f4ff' 8 | } 9 | } 10 | }, 11 | plugins: [], 12 | corePlugins: { 13 | preflight: false 14 | } 15 | }; 16 | -------------------------------------------------------------------------------- /client/src/main.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom/client'; 3 | import App from './App'; 4 | 5 | import { inject } from '@vercel/analytics'; 6 | 7 | inject(); 8 | 9 | ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render( 10 | 11 | 12 | 13 | ); 14 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | client: 4 | build: 5 | context: . 6 | dockerfile: docker/Dockerfile.client 7 | ports: 8 | - "8081:80" 9 | server: 10 | build: 11 | context: . 12 | dockerfile: docker/Dockerfile.server 13 | ports: 14 | - "8080:8080" 15 | volumes: 16 | - ./data:/server/static 17 | - ./logs:/server/logs 18 | 19 | -------------------------------------------------------------------------------- /docker/Dockerfile.client: -------------------------------------------------------------------------------- 1 | FROM node:16-alpine as client 2 | 3 | WORKDIR /client 4 | 5 | COPY ./client . 6 | 7 | RUN yarn install 8 | 9 | RUN yarn build 10 | 11 | RUN rm -rf node_modules 12 | RUN rm -rf src 13 | 14 | FROM nginx:1.23.4-alpine 15 | 16 | COPY --from=client /client/dist /usr/share/nginx/html 17 | COPY nginx.conf /etc/nginx/conf.d/default.conf 18 | 19 | EXPOSE 80 20 | 21 | CMD ["nginx", "-g", "daemon off;"] 22 | -------------------------------------------------------------------------------- /client/src/utils/fetch.ts: -------------------------------------------------------------------------------- 1 | import { baseURL } from './request'; 2 | import queryString from 'query-string'; 3 | 4 | export default async function fetchRequest(url: string, params: { [key: string]: any }) { 5 | const combineUrl = queryString.stringifyUrl({ 6 | url: `${baseURL}${url}`, 7 | query: params 8 | }); 9 | 10 | const res = await fetch(combineUrl); 11 | 12 | if (res.ok) { 13 | return res; 14 | } 15 | 16 | return Promise.reject(res.statusText); 17 | } 18 | -------------------------------------------------------------------------------- /client/src/utils/request.ts: -------------------------------------------------------------------------------- 1 | import { message } from 'antd'; 2 | import axios from 'axios'; 3 | 4 | export const baseURL = import.meta.env.VITE_SERVICES_URL || 'http://localhost:8080'; 5 | 6 | const request = axios.create({ 7 | baseURL 8 | }); 9 | 10 | request.interceptors.response.use( 11 | function (response) { 12 | return response; 13 | }, 14 | function (error) { 15 | message.error(error.response.data.message); 16 | return Promise.reject(error); 17 | } 18 | ); 19 | 20 | export default request; 21 | -------------------------------------------------------------------------------- /.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 | dist 12 | dist-ssr 13 | *.local 14 | 15 | # Editor directories and files 16 | .vscode/* 17 | !.vscode/extensions.json 18 | .idea 19 | .DS_Store 20 | *.suo 21 | *.ntvs* 22 | *.njsproj 23 | *.sln 24 | *.sw? 25 | 26 | .env 27 | 28 | # python 29 | .vercel 30 | *.pyc 31 | __pycache__/ 32 | .venv/ 33 | *.pyo 34 | *.pyd 35 | instance/ 36 | build 37 | *.spec 38 | temp 39 | 40 | data 41 | -------------------------------------------------------------------------------- /nginx.conf: -------------------------------------------------------------------------------- 1 | server { 2 | listen 80; 3 | 4 | location ~ /(api|static) { 5 | proxy_pass http://server:8080; 6 | proxy_set_header Host $host; 7 | proxy_set_header X-Real-IP $remote_addr; 8 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 9 | proxy_set_header X-Forwarded-Proto $scheme; 10 | } 11 | 12 | location / { 13 | alias /usr/share/nginx/html/; 14 | try_files $uri /index.html; 15 | if ($request_filename ~ .*\.(htm|html)$) { 16 | add_header Cache-Control 'no-store, no-cache, must-revalidate'; 17 | } 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /client/src/utils/useOpenAiKey.ts: -------------------------------------------------------------------------------- 1 | import { useEffect, useState } from 'react'; 2 | import eventEmitter from './eventEmitter'; 3 | 4 | export default function useOpenAiKey() { 5 | const [apiKey, setApiKey] = useState(null); 6 | 7 | const getApiKey = () => { 8 | const apiKey = JSON.parse(localStorage.getItem('settings') as string)?.apiKey || null; 9 | setApiKey(apiKey); 10 | }; 11 | 12 | useEffect(() => { 13 | getApiKey(); 14 | 15 | eventEmitter.on('refreshSettings', getApiKey); 16 | return () => { 17 | eventEmitter.off('refreshSettings', getApiKey); 18 | }; 19 | }, []); 20 | 21 | return apiKey; 22 | } 23 | -------------------------------------------------------------------------------- /server/static/testFiles/no-match-heading-test.md: -------------------------------------------------------------------------------- 1 | The Test File chunk size is 10 2 | 3 | #### list 4 | 5 | - first 6 | - second 7 | - third 8 | 9 | #### Table 10 | 11 | | Syntax | Description | 12 | | --------- | ----------- | 13 | | Header | Title | 14 | | Paragraph | Text | 15 | 16 | #### CodeBlock 17 | 18 | ``` 19 | { 20 | "firstName": "John", 21 | "lastName": "Smith", 22 | "age": 25 23 | } 24 | ``` 25 | 26 | #### Other 27 | 28 | long text**strong**long textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong text 29 | -------------------------------------------------------------------------------- /server/static/testFiles/heading-test.md: -------------------------------------------------------------------------------- 1 | # Test Markdown 2 | 3 | The Test File chunk size is 10 4 | 5 | ## list 6 | 7 | - first 8 | - second 9 | - third 10 | 11 | ## Table 12 | 13 | | Syntax | Description | 14 | | --------- | ----------- | 15 | | Header | Title | 16 | | Paragraph | Text | 17 | 18 | ## CodeBlock 19 | 20 | ``` 21 | { 22 | "firstName": "John", 23 | "lastName": "Smith", 24 | "age": 25 25 | } 26 | ``` 27 | 28 | ## Other 29 | 30 | long text**strong**long textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong text 31 | -------------------------------------------------------------------------------- /client/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "ESNext", 4 | "useDefineForClassFields": true, 5 | "lib": ["DOM", "DOM.Iterable", "ESNext"], 6 | "allowJs": false, 7 | "skipLibCheck": true, 8 | "esModuleInterop": false, 9 | "allowSyntheticDefaultImports": true, 10 | "strict": true, 11 | "forceConsistentCasingInFileNames": true, 12 | "module": "ESNext", 13 | "moduleResolution": "Node", 14 | "resolveJsonModule": true, 15 | "isolatedModules": true, 16 | "noEmit": true, 17 | "jsx": "react-jsx" 18 | }, 19 | "include": ["src"], 20 | "references": [{ "path": "./tsconfig.node.json" }] 21 | } 22 | -------------------------------------------------------------------------------- /client/src/components/htmlViewer/index.tsx: -------------------------------------------------------------------------------- 1 | import { useEffect, useRef } from 'react'; 2 | import PageSpin from '../pageSpin'; 3 | 4 | export default function HtmlViewer({ html, loading }: { html: string; loading: boolean }) { 5 | const htmlRef = useRef(null); 6 | 7 | useEffect(() => { 8 | if (htmlRef.current) { 9 | htmlRef.current.scrollTop = 0; 10 | } 11 | }, [html]); 12 | 13 | return ( 14 |
18 | {loading ? :
} 19 |
20 | ); 21 | } 22 | -------------------------------------------------------------------------------- /.github/workflows/issue.yml: -------------------------------------------------------------------------------- 1 | name: 'Close stale issues' 2 | 3 | permissions: 4 | contents: write # only for delete-branch option 5 | issues: write 6 | pull-requests: write 7 | 8 | on: 9 | schedule: 10 | - cron: '30 1 * * *' 11 | 12 | jobs: 13 | stale: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/stale@v8 17 | with: 18 | stale-issue-message: 'This issue is stale because it has been open 5 days with no activity. Remove stale label or comment or this will be closed in 2 days.' 19 | close-issue-message: 'This issue was closed because it has been stalled for 2 days with no activity.' 20 | days-before-issue-stale: 5 21 | days-before-issue-close: 2 22 | days-before-pr-close: -1 -------------------------------------------------------------------------------- /client/.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "es2021": true 5 | }, 6 | "extends": ["eslint:recommended", "plugin:react/recommended", "plugin:@typescript-eslint/recommended", "prettier"], 7 | "overrides": [], 8 | "parser": "@typescript-eslint/parser", 9 | "parserOptions": { 10 | "ecmaVersion": "latest", 11 | "sourceType": "module" 12 | }, 13 | "plugins": ["react", "react-hooks", "@typescript-eslint", "prettier"], 14 | "rules": { 15 | "react/react-in-jsx-scope": "off", 16 | "@typescript-eslint/no-explicit-any": "off", 17 | "prettier/prettier": [ 18 | "error", 19 | { 20 | "endOfLine": "auto" 21 | } 22 | ] 23 | }, 24 | "settings": { 25 | "import/resolver": { 26 | "typescript": {} 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /client/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | DocsMind 8 | 12 | 13 | 14 | 18 | 22 | 23 | 24 |
25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /client/src/components/fileCard/index.tsx: -------------------------------------------------------------------------------- 1 | import { FilePdfTwoTone, FileTextTwoTone } from '@ant-design/icons'; 2 | import { Card, Space } from 'antd'; 3 | import classNames from 'classnames'; 4 | import { MouseEventHandler } from 'react'; 5 | import FileItem from '../../constants/fileItem'; 6 | import isPdf from '../../utils/isPdf'; 7 | 8 | interface FileCardProps { 9 | item: FileItem; 10 | active?: boolean; 11 | onClick: MouseEventHandler; 12 | } 13 | 14 | export default function FileCard({ item, onClick, active }: FileCardProps) { 15 | return ( 16 | 23 | 24 | {isPdf(item.ext) ? : } 25 |
{item.name.split(item.ext)}
26 | 27 | 28 | ); 29 | } 30 | -------------------------------------------------------------------------------- /server/static/file/heading-test.html: -------------------------------------------------------------------------------- 1 |

Test Markdown

2 |

The Test File chunk size is 10

3 |

list

4 |
    5 |
  • first
    • 6 |
  • second
    • 7 |
  • third
    • 8 |
9 |

Table

10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 |
SyntaxDescription
HeaderTitle
ParagraphText
28 |

CodeBlock

29 | 
{
30 |   "firstName": "John",
31 |   "lastName": "Smith",
32 |   "age": 25
33 | }
34 |
35 |

Other

36 |

long textstronglong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong textlong text

-------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: 🐞 Bug Report 2 | description: Create a report to help us improve 3 | title: "[Bug]: " 4 | labels: ["bug"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thanks for taking the time to fill out this bug report! 10 | - type: textarea 11 | id: description 12 | attributes: 13 | label: Describe the bug 14 | description: A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem. 15 | validations: 16 | required: true 17 | - type: textarea 18 | id: logs 19 | attributes: 20 | label: Relevant log output 21 | description: Please copy and paste any relevant log located at `logs/app.log` and the client error (browser console) so that I can better understand the issue. If there are no errors, fill in no 22 | render: shell 23 | validations: 24 | required: true 25 | - type: checkboxes 26 | id: validations 27 | attributes: 28 | label: Validations 29 | description: Before submitting the issue, please make sure you do the following 30 | options: 31 | - label: Already read the README 32 | required: true 33 | - label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. 34 | required: true 35 | validations: 36 | required: true -------------------------------------------------------------------------------- /client/src/components/settingsModal/index.tsx: -------------------------------------------------------------------------------- 1 | import { Form, Input, Modal } from 'antd'; 2 | import { useEffect, useRef } from 'react'; 3 | import eventEmitter from '../../utils/eventEmitter'; 4 | 5 | interface SettingsModalProps { 6 | open: boolean; 7 | onChange: (open: boolean) => void; 8 | } 9 | 10 | export default function SettingsModal({ open, onChange }: SettingsModalProps) { 11 | const settings = useRef(null); 12 | const [form] = Form.useForm(); 13 | 14 | useEffect(() => { 15 | const localSettings = JSON.parse(localStorage.getItem('settings') as string); 16 | settings.current = localSettings; 17 | }, [open]); 18 | 19 | const onSaveSettings = () => { 20 | form 21 | .validateFields() 22 | .then((values) => { 23 | localStorage.setItem('settings', JSON.stringify(values)); 24 | onChange(false); 25 | eventEmitter.emit('refreshSettings'); 26 | }) 27 | .catch((info) => { 28 | console.log('Validate Failed:', info); 29 | }); 30 | }; 31 | 32 | return ( 33 | onChange(false)}> 34 |
40 | 45 | 46 | 47 |
48 | 49 | ); 50 | } 51 | -------------------------------------------------------------------------------- /server/create_index.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | import markdown 4 | from custom_loader import CustomReader 5 | from llama_index import GPTSimpleVectorIndex, MockEmbedding, ServiceContext 6 | from pdf_loader import CJKPDFReader 7 | 8 | staticPath = "static" 9 | 10 | 11 | def create_index(filepath, filename) -> int: 12 | name, ext = os.path.splitext(filename) 13 | 14 | if ext == ".pdf": 15 | loader = CJKPDFReader() 16 | documents = loader.load_data(filepath=filepath, filename=filename) 17 | elif ext == ".md": 18 | with open(filepath, "r", encoding="utf-8") as f: 19 | file_text = f.read() 20 | html = markdown.markdown( 21 | file_text, extensions=["pymdownx.superfences", "tables", "pymdownx.details"] 22 | ) 23 | # TODO: 利用 langchain splitter重写 https://python.langchain.com/en/latest/modules/indexes/text_splitters/examples/markdown.html 24 | # 直接将markdown分段再分别转化成html，最后将所有html拼接起来并加上chunk_id 25 | loader = CustomReader() 26 | documents = loader.load_data(html=html, filename=name) 27 | elif ext == ".html": 28 | # TODO: 29 | pass 30 | 31 | # predictor cost 32 | embed_model = MockEmbedding(embed_dim=1536) 33 | service_context = ServiceContext.from_defaults(embed_model=embed_model) 34 | index = GPTSimpleVectorIndex.from_documents( 35 | documents, service_context=service_context 36 | ) 37 | 38 | index = GPTSimpleVectorIndex.from_documents(documents) 39 | 40 | # save to disk 41 | index.save_to_disk(f"{staticPath}/index/{name}.json") 42 | 43 | return embed_model.last_token_usage 44 | -------------------------------------------------------------------------------- /client/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "docs-mind", 3 | "private": true, 4 | "version": "0.0.0", 5 | "type": "module", 6 | "scripts": { 7 | "dev": "vite", 8 | "build": "tsc && vite build", 9 | "preview": "vite preview", 10 | "lint": "eslint --ext js,jsx,ts,tsx src", 11 | "lint:fix": "eslint --ext js,jsx,ts,tsx src --fix" 12 | }, 13 | "dependencies": { 14 | "@ant-design/icons": "^5.0.1", 15 | "@types/lodash": "^4.14.191", 16 | "@vercel/analytics": "^0.1.11", 17 | "antd": "^5.3.0", 18 | "axios": "^1.3.4", 19 | "canvas-confetti": "^1.6.0", 20 | "classnames": "^2.3.2", 21 | "github-markdown-css": "^5.2.0", 22 | "lodash": "^4.17.21", 23 | "mitt": "^3.0.0", 24 | "query-string": "^8.1.0", 25 | "react": "^18.2.0", 26 | "react-dom": "^18.2.0", 27 | "react-pdf": "^6.2.2", 28 | "react-router-dom": "^6.9.0" 29 | }, 30 | "devDependencies": { 31 | "@types/canvas-confetti": "^1.6.0", 32 | "@types/react": "^18.0.28", 33 | "@types/react-dom": "^18.0.11", 34 | "@types/react-pdf": "^6.2.0", 35 | "@typescript-eslint/eslint-plugin": "^5.57.0", 36 | "@typescript-eslint/parser": "^5.57.0", 37 | "@vitejs/plugin-react": "^3.1.0", 38 | "autoprefixer": "^10.4.14", 39 | "eslint": "^8.37.0", 40 | "eslint-config-prettier": "^8.8.0", 41 | "eslint-import-resolver-typescript": "^3.5.4", 42 | "eslint-plugin-import": "^2.27.5", 43 | "eslint-plugin-prettier": "^4.2.1", 44 | "eslint-plugin-react": "^7.32.2", 45 | "eslint-plugin-react-hooks": "^4.6.0", 46 | "postcss": "^8.4.21", 47 | "prettier": "^2.8.7", 48 | "sass": "^1.62.1", 49 | "tailwindcss": "^3.3.0", 50 | "typescript": "^4.9.3", 51 | "vite": "^4.2.0" 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /client/src/components/pdfViewer/index.tsx: -------------------------------------------------------------------------------- 1 | import { Document, Page } from 'react-pdf/dist/esm/entry.vite'; 2 | import 'react-pdf/dist/esm/Page/TextLayer.css'; 3 | import 'react-pdf/dist/esm/Page/AnnotationLayer.css'; 4 | import type { PDFDocumentProxy } from 'pdfjs-dist'; 5 | import { useEffect, useRef, useState } from 'react'; 6 | import eventEmitter from '../../utils/eventEmitter'; 7 | import PageSpin from '../pageSpin'; 8 | 9 | export default function PdfViewer({ file }: { file: Blob }) { 10 | const [numPages, setNumPages] = useState(); 11 | const pdfRef = useRef(null); 12 | 13 | function scrollToPage(meta: { pageNo: number; time: number }) { 14 | const { pageNo, time } = meta; 15 | 16 | setTimeout(() => { 17 | if (pdfRef?.current) { 18 | pdfRef.current?.children[pageNo - 1].scrollIntoView(); 19 | } 20 | }, time); 21 | } 22 | 23 | useEffect(() => { 24 | eventEmitter.on('scrollToPage', scrollToPage); 25 | 26 | return () => { 27 | eventEmitter.off('scrollToPage', scrollToPage); 28 | }; 29 | }, []); 30 | 31 | function onDocumentLoadSuccess({ numPages: nextNumPages }: PDFDocumentProxy) { 32 | setNumPages(nextNumPages); 33 | } 34 | 35 | return ( 36 | } 39 | className="w-[700px] bg-white h-full overflow-auto relative scroll-smooth rounded-lg shadow-md" 40 | file={file} 41 | onLoadSuccess={onDocumentLoadSuccess} 42 | options={{ 43 | cMapUrl: 'cmaps/', 44 | standardFontDataUrl: 'standard_fonts/' 45 | }} 46 | > 47 | {Array.from(new Array(numPages), (_el, index) => ( 48 | 49 | ))} 50 | 51 | ); 52 | } 53 | -------------------------------------------------------------------------------- /server/requirements.txt: -------------------------------------------------------------------------------- 1 | aiohttp==3.8.4 2 | aiosignal==1.3.1 3 | anyio==3.6.2 4 | argilla==1.5.1 5 | async-timeout==4.0.2 6 | attrs==22.2.0 7 | backoff==2.2.1 8 | beautifulsoup4==4.12.0 9 | blinker==1.6.2 10 | bs4==0.0.1 11 | cachetools==5.3.0 12 | certifi==2022.12.7 13 | cffi==1.15.1 14 | charset-normalizer==3.1.0 15 | click==8.1.3 16 | colorama==0.4.6 17 | commonmark==0.9.1 18 | cryptography==40.0.2 19 | dataclasses-json==0.5.7 20 | Deprecated==1.2.13 21 | et-xmlfile==1.1.0 22 | Flask==2.3.2 23 | Flask-Cors==3.0.10 24 | frozenlist==1.3.3 25 | geojson==2.5.0 26 | gptcache==0.1.21 27 | greenlet==2.0.2 28 | gunicorn==20.1.0 29 | h11==0.14.0 30 | httpcore==0.16.3 31 | httpx==0.23.3 32 | idna==3.4 33 | importlib-metadata==6.1.0 34 | itsdangerous==2.1.2 35 | Jinja2==3.1.2 36 | joblib==1.2.0 37 | langchain==0.0.142 38 | llama-index==0.5.27 39 | lxml==4.9.2 40 | Markdown==3.4.3 41 | MarkupSafe==2.1.2 42 | marshmallow==3.19.0 43 | marshmallow-enum==1.5.1 44 | monotonic==1.6 45 | msg-parser==1.2.0 46 | multidict==6.0.4 47 | mypy-extensions==1.0.0 48 | nltk==3.8.1 49 | numexpr==2.8.4 50 | numpy==1.23.5 51 | olefile==0.46 52 | openai==0.27.2 53 | openapi-schema-pydantic==1.2.4 54 | openpyxl==3.1.2 55 | packaging==23.0 56 | pandas==1.5.3 57 | pdfminer.six==20221105 58 | Pillow==9.4.0 59 | pycparser==2.21 60 | pydantic==1.10.7 61 | Pygments==2.14.0 62 | pymdown-extensions==9.10 63 | pyowm==3.3.0 64 | pypandoc==1.11 65 | PySocks==1.7.1 66 | python-dateutil==2.8.2 67 | python-docx==0.8.11 68 | python-dotenv==1.0.0 69 | python-magic==0.4.27 70 | python-pptx==0.6.21 71 | pytz==2023.3 72 | PyYAML==6.0 73 | regex==2023.3.23 74 | requests==2.28.2 75 | rfc3986==1.5.0 76 | rich==13.0.1 77 | six==1.16.0 78 | sniffio==1.3.0 79 | soupsieve==2.4 80 | SQLAlchemy==1.4.47 81 | tenacity==8.2.2 82 | tiktoken==0.3.3 83 | tqdm==4.65.0 84 | typing-inspect==0.8.0 85 | typing_extensions==4.5.0 86 | unstructured==0.5.8 87 | urllib3==1.26.15 88 | Werkzeug==2.3.3 89 | wrapt==1.14.1 90 | XlsxWriter==3.0.9 91 | yarl==1.8.2 92 | zipp==3.15.0 93 | -------------------------------------------------------------------------------- /client/src/components/upload/index.tsx: -------------------------------------------------------------------------------- 1 | import { InboxOutlined } from '@ant-design/icons'; 2 | import { message, Spin, Upload } from 'antd'; 3 | import { useState } from 'react'; 4 | import confetti from 'canvas-confetti'; 5 | import { baseURL } from '../../utils/request'; 6 | import useOpenAiKey from '../../utils/useOpenAiKey'; 7 | import eventEmitter from '../../utils/eventEmitter'; 8 | 9 | const { Dragger } = Upload; 10 | 11 | function generateConfetti() { 12 | confetti({ 13 | spread: 90, 14 | particleCount: 80, 15 | origin: { y: 0.5 }, 16 | ticks: 300 17 | }); 18 | } 19 | 20 | export default function FileUpload() { 21 | const [uploading, setUploading] = useState(false); 22 | const openAiKey = useOpenAiKey(); 23 | 24 | const onUploadChange = (info: any) => { 25 | setUploading(true); 26 | const { status } = info.file; 27 | if (status === 'done' || status === 'success') { 28 | generateConfetti(); 29 | void message.success({ 30 | content: `${info.file.name} file uploaded successfully. token usage: 💰 ${info.file.response}`, 31 | duration: 8 32 | }); 33 | eventEmitter.emit('refreshFileList'); 34 | setUploading(false); 35 | } else if (status === 'error') { 36 | void message.error( 37 | `${info.file.name} file upload failed. ${JSON.stringify(info.file.response)}` 38 | ); 39 | setUploading(false); 40 | } 41 | }; 42 | 43 | return ( 44 |
45 | 46 | 56 |

57 | 58 |

59 |

Click or drag file to this area to upload

60 |

Support .md,.pdf

61 | 62 | 63 |
64 | ); 65 | } 66 | -------------------------------------------------------------------------------- /client/src/components/sideMenu/index.tsx: -------------------------------------------------------------------------------- 1 | import { Alert, Button, Divider, Space } from 'antd'; 2 | import FileItem from '../../constants/fileItem'; 3 | import FileCard from '../fileCard'; 4 | import FileUpload from '../upload'; 5 | import { GithubOutlined, SettingOutlined } from '@ant-design/icons'; 6 | 7 | interface SideMenuProps { 8 | fileList: FileItem[]; 9 | activeFile: string; 10 | onFileClick: (item: FileItem) => void; 11 | onOpenSetting: () => void; 12 | } 13 | 14 | const disableUpload = import.meta.env.VITE_DISABLED_UPLOAD; 15 | 16 | export default function SideMenu({ 17 | fileList, 18 | onFileClick, 19 | activeFile, 20 | onOpenSetting 21 | }: SideMenuProps) { 22 | return ( 23 |
24 |
25 | {fileList.map((item) => ( 26 | onFileClick(item)} 30 | item={item} 31 | /> 32 | ))} 33 |
34 | 35 | 36 | 37 | {disableUpload ? ( 38 | 42 | The upload is not available on the current website. You can 43 | 44 | {' '} 45 | fork and clone the project{' '} 46 | 47 | to your local device to complete the upload. 48 | 49 | } 50 | /> 51 | ) : ( 52 | 53 | )} 54 | 55 |
56 | Made by Alan 57 | 58 | 59 | 64 | 65 | 66 |
67 |
68 | ); 69 | } 70 | -------------------------------------------------------------------------------- /client/src/components/chatWindow/Loading.tsx: -------------------------------------------------------------------------------- 1 | export default function Loading() { 2 | return ( 3 | 4 | 11 | 12 | 22 | 32 | 33 | 34 | 44 | 54 | 55 | 56 | 66 | 76 | 77 | 78 | 79 | ); 80 | } 81 | -------------------------------------------------------------------------------- /client/src/styles/globals.scss: -------------------------------------------------------------------------------- 1 | @tailwind base; 2 | @tailwind components; 3 | @tailwind utilities; 4 | 5 | :root { 6 | font-family: Inter, Avenir, Helvetica, Arial, sans-serif; 7 | font-size: 16px; 8 | line-height: 24px; 9 | font-weight: 400; 10 | 11 | color: #0f0f0f; 12 | background-color: #f6f6f6; 13 | 14 | font-synthesis: none; 15 | text-rendering: optimizeLegibility; 16 | -webkit-font-smoothing: antialiased; 17 | -moz-osx-font-smoothing: grayscale; 18 | -webkit-text-size-adjust: 100%; 19 | } 20 | 21 | * { 22 | margin: 0; 23 | box-sizing: border-box; 24 | } 25 | 26 | body { 27 | position: fixed; 28 | width: 100%; 29 | height: 100%; 30 | overflow: hidden; 31 | } 32 | 33 | .markdown-body { 34 | table { 35 | &.hl-source { 36 | border-radius: 0; 37 | 38 | tr, td { 39 | background-color: #eff6ff; 40 | border-radius: 0; 41 | } 42 | } 43 | } 44 | 45 | .hl-source { 46 | background-color: #eff6ff; 47 | border-radius: 6px; 48 | 49 | pre { 50 | background-color: #eff6ff !important; 51 | } 52 | } 53 | } 54 | 55 | .markdown-body { 56 | box-sizing: border-box; 57 | min-width: 200px; 58 | max-width: 980px; 59 | margin: 0 auto; 60 | padding: 20px 40px; 61 | } 62 | 63 | /* 修改滚动条的宽度和颜色 */ 64 | ::-webkit-scrollbar { 65 | width: 8px; 66 | height: 8px; 67 | background-color: #f2f2f2; 68 | } 69 | 70 | /* 修改滚动条滑块的样式 */ 71 | ::-webkit-scrollbar-thumb { 72 | background-color: #ccc; 73 | border-radius: 5px; 74 | } 75 | 76 | /* 修改滚动条滑块悬停时的样式 */ 77 | ::-webkit-scrollbar-thumb:hover { 78 | background-color: #999; 79 | } 80 | 81 | /* 修改滚动条轨道的样式 */ 82 | ::-webkit-scrollbar-track { 83 | background-color: #fff; 84 | border-radius: 8px; 85 | } 86 | 87 | .markdown-body video { 88 | width: 100%; 89 | } 90 | 91 | // TODO: 使用 antd 的 Token实现 92 | 93 | .ant-menu-item { 94 | padding-left: 16px !important; 95 | } 96 | 97 | .ant-menu-item-active { 98 | background-color: #eff6ff; 99 | } 100 | 101 | .ant-collapse-header { 102 | padding: 4px 12px; 103 | } 104 | 105 | .ant-collapse-content-box { 106 | font-size: 12px; 107 | padding: 8px 12px !important; 108 | } 109 | 110 | .react-pdf__message--loading { 111 | height: 100%; 112 | } 113 | 114 | @media (prefers-color-scheme: dark) { 115 | } 116 | -------------------------------------------------------------------------------- /client/src/App.tsx: -------------------------------------------------------------------------------- 1 | import './styles/globals.scss'; 2 | import 'github-markdown-css/github-markdown-light.css'; 3 | import { BrowserRouter, Route, Routes } from 'react-router-dom'; 4 | import routes from './routes'; 5 | import SideMenu from './components/sideMenu'; 6 | import SettingsModal from './components/settingsModal'; 7 | import { useEffect, useState } from 'react'; 8 | import request from './utils/request'; 9 | import FileItem from './constants/fileItem'; 10 | import { CurrentFileContext } from './context/currentFile'; 11 | import eventEmitter from './utils/eventEmitter'; 12 | 13 | const App = () => { 14 | const [currentFile, setCurrentFile] = useState(null); 15 | const [fileList, setFileList] = useState([]); 16 | const [showSettingModal, setShowSettingModal] = useState(false); 17 | 18 | async function getFileList() { 19 | const res = await request('/api/file-list'); 20 | setFileList(res.data); 21 | 22 | if (res.data.length > 0) { 23 | setCurrentFile(res.data[0]); 24 | } 25 | } 26 | 27 | function handleFileClick(item: any) { 28 | const file = fileList.find((f) => f.name === item.name) || null; 29 | setCurrentFile(file); 30 | } 31 | 32 | function toggleSettingModal(open: boolean) { 33 | setShowSettingModal(open); 34 | } 35 | 36 | useEffect(() => { 37 | getFileList(); 38 | 39 | eventEmitter.on('refreshFileList', getFileList); 40 | return () => { 41 | eventEmitter.off('refreshFileList', getFileList); 42 | }; 43 | }, []); 44 | 45 | return ( 46 | 47 |
48 | toggleSettingModal(true)} 53 | /> 54 | 55 |
56 | 57 | 58 | {routes.map((route) => ( 59 | 60 | ))} 61 | 62 | 63 |
64 |
65 | 66 | ); 67 | }; 68 | 69 | export default App; 70 | -------------------------------------------------------------------------------- /server/pdf_loader.py: -------------------------------------------------------------------------------- 1 | """Read PDF files.""" 2 | 3 | import shutil 4 | from pathlib import Path 5 | from typing import Any, List 6 | 7 | from llama_index.langchain_helpers.text_splitter import SentenceSplitter 8 | from llama_index.readers.base import BaseReader 9 | from llama_index.readers.schema.base import Document 10 | 11 | # https://github.com/emptycrown/llama-hub/blob/main/loader_hub/file/cjk_pdf/base.py 12 | 13 | staticPath = "static" 14 | 15 | 16 | class CJKPDFReader(BaseReader): 17 | """CJK PDF reader. 18 | 19 | Extract text from PDF including CJK (Chinese, Japanese and Korean) languages using pdfminer.six. 20 | """ 21 | 22 | def __init__(self, *args: Any, **kwargs: Any) -> None: 23 | """Init params.""" 24 | super().__init__(*args, **kwargs) 25 | 26 | def load_data(self, filepath: Path, filename) -> List[Document]: 27 | """Parse file.""" 28 | 29 | # Import pdfminer 30 | from io import StringIO 31 | 32 | from pdfminer.converter import TextConverter 33 | from pdfminer.layout import LAParams 34 | from pdfminer.pdfinterp import PDFPageInterpreter, PDFResourceManager 35 | from pdfminer.pdfpage import PDFPage 36 | 37 | # Create a resource manager 38 | rsrcmgr = PDFResourceManager() 39 | # Create an object to store the text 40 | retstr = StringIO() 41 | # Create a text converter 42 | codec = "utf-8" 43 | laparams = LAParams() 44 | device = TextConverter(rsrcmgr, retstr, codec=codec, laparams=laparams) 45 | # Create a PDF interpreter 46 | interpreter = PDFPageInterpreter(rsrcmgr, device) 47 | # Open the PDF file 48 | fp = open(filepath, "rb") 49 | # Create a list to store the text of each page 50 | document_list = [] 51 | # Extract text from each page 52 | for i, page in enumerate(PDFPage.get_pages(fp)): 53 | interpreter.process_page(page) 54 | 55 | # Get the text 56 | text = retstr.getvalue() 57 | 58 | sentence_splitter = SentenceSplitter(chunk_size=400) 59 | text_chunks = sentence_splitter.split_text(text) 60 | 61 | document_list += [ 62 | Document(t, extra_info={"page_no": i + 1}) for t in text_chunks 63 | ] 64 | # Clear the text 65 | retstr.truncate(0) 66 | retstr.seek(0) 67 | # Close the file 68 | fp.close() 69 | # Close the device 70 | device.close() 71 | 72 | shutil.copy2(filepath, f"{staticPath}/file/{filename}") 73 | 74 | return document_list 75 | -------------------------------------------------------------------------------- /Deployment.md: -------------------------------------------------------------------------------- 1 | The first thing you need to know is that this project includes frontend (UI) and backend. I strongly recommend using Docker for deployment. 2 | 3 | If you just want to try it out instead of using it in a production environment, you can deploy it using Vercel + Railway. 4 | 5 | ## Docker 6 | 7 | Fork the repository and clone the code to your local machine. 8 | 9 | > **Warning** 10 | > 11 | > Please check if you can access OpenAI in your region, you can refer to the [issue](https://github.com/3Alan/DocsMind/issues/3#issuecomment-1511470063) for more information. 12 | 13 | 1. Create .env 14 | 15 | Create a `.env` file and copy the contents of `.env.example` to modify it. 16 | 17 | 2. Run App 18 | 19 | ```bash 20 | docker-compose up -d 21 | ``` 22 | 23 | Please add `--build` to rebuild the image after each code update. 24 | 25 | ```bash 26 | docker-compose up -d --build 27 | ``` 28 | 29 | now you can access the app at `http://localhost:8081` 30 | 31 | All data will be saved in the `./data` directory. 32 | 33 | ## Vercel + Railway 34 | 35 | > **Warning** 36 | > 37 | > ❗❗❗ if you want to use this project in a production environment, do not deploy it in this way. All data will be cleared when you redeploy. 38 | 39 | We will deploy the code separately to Vercel and Railway. 40 | 41 | Please follow the steps one by one. 42 | 43 | ### Railway 44 | 45 | Deploy the backend using the following template. 46 | 47 | [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/HcW7kc?referralCode=Hk0oZ6) 48 | 49 | Do not check Private repository. 50 | ![20230511150842](https://raw.githubusercontent.com/3Alan/images/master/img/20230511150842.png) 51 | 52 | After deployment, you will receive a domain. Copy it as it will be used later. 53 | ![20230511135709](https://raw.githubusercontent.com/3Alan/images/master/img/20230511135709.png) 54 | 55 | You can also customize the domain. 56 | ![20230511140533](https://raw.githubusercontent.com/3Alan/images/master/img/20230511140533.png) 57 | 58 | ### Vercel 59 | 60 | 1. Select the repository created by Railway. 61 | 2. Change the Root Directory to "client". 62 | 3. Change the Framework Preset to "Vite". 63 | 4. Add an environment variable `VITE_SERVICES_URL` with the value of Railway's Domain. 64 | 65 | ![20230511141639](https://raw.githubusercontent.com/3Alan/images/master/img/20230511141639.png) 66 | 67 | ![20230511141851](https://raw.githubusercontent.com/3Alan/images/master/img/20230511141851.png) 68 | 69 | Now you can upload your files, ❗❗❗ but please be reminded that all data will be cleared once you redeploy. 70 | 71 | **If you have a better deployment method, please feel free to share the tutorial and submit a pull request.** 72 | -------------------------------------------------------------------------------- /client/src/pages/Home.tsx: -------------------------------------------------------------------------------- 1 | import { Empty } from 'antd'; 2 | import { useContext, useEffect, useState } from 'react'; 3 | import ChatWindow from '../components/chatWindow'; 4 | import request from '../utils/request'; 5 | import eventEmitter from '../utils/eventEmitter'; 6 | import PdfViewer from '../components/pdfViewer'; 7 | import { isEmpty, has } from 'lodash'; 8 | import FileItem from '../constants/fileItem'; 9 | import { CurrentFileContext } from '../context/currentFile'; 10 | import isPdf from '../utils/isPdf'; 11 | import HtmlViewer from '../components/htmlViewer'; 12 | 13 | function removeHighLight() { 14 | const highLightElements = document.querySelectorAll('.hl-source'); 15 | highLightElements?.forEach((element) => { 16 | element.classList.remove('hl-source'); 17 | }); 18 | } 19 | 20 | function addHighLight(chunkId: string, time = 400) { 21 | removeHighLight(); 22 | const firstElement = document.querySelector(`[data-chunk_id=${chunkId}]`); 23 | setTimeout(() => { 24 | firstElement?.scrollIntoView({ behavior: 'smooth' }); 25 | }, time); 26 | 27 | const highLightElements = document.querySelectorAll(`[data-chunk_id=${chunkId}]`); 28 | 29 | highLightElements?.forEach((element) => { 30 | element.classList.add('hl-source'); 31 | }); 32 | } 33 | 34 | async function downloadFile(fileItem: FileItem) { 35 | let res; 36 | if (isPdf(fileItem.ext)) { 37 | res = await request(fileItem.path, { 38 | responseType: 'blob' 39 | }); 40 | } else { 41 | res = await request(fileItem.path); 42 | } 43 | 44 | return res.data; 45 | } 46 | 47 | const Home = () => { 48 | const [file, setFile] = useState(null); 49 | const [loading, setLoading] = useState(false); 50 | const currentFile = useContext(CurrentFileContext); 51 | 52 | useEffect(() => { 53 | eventEmitter.emit('cleanChat'); 54 | 55 | getFile(); 56 | }, [currentFile]); 57 | 58 | async function getFile() { 59 | if (currentFile) { 60 | setLoading(true); 61 | const file = await downloadFile(currentFile); 62 | setLoading(false); 63 | 64 | setFile(file); 65 | } 66 | } 67 | 68 | function handleHighLight(item: any, time = 400) { 69 | if (isEmpty(item)) { 70 | return; 71 | } 72 | 73 | // PDF 74 | if (has(item.extraInfo, 'page_no')) { 75 | eventEmitter.emit('scrollToPage', { pageNo: item.extraInfo.page_no, time }); 76 | } else { 77 | addHighLight(item.extraInfo.chunk_id, time); 78 | } 79 | } 80 | 81 | return ( 82 |
83 |
84 | {file ? ( 85 | <> 86 | {isPdf(currentFile?.ext || '') ? ( 87 | 88 | ) : ( 89 | 90 | )} 91 | 92 | ) : ( 93 | No uploaded file.} 98 | /> 99 | )} 100 |
101 | 102 | handleHighLight(item, 0)} 108 | /> 109 |
110 | ); 111 | }; 112 | 113 | export default Home; 114 | -------------------------------------------------------------------------------- /client/src/components/chatWindow/Message.tsx: -------------------------------------------------------------------------------- 1 | import { DollarOutlined, HighlightOutlined } from '@ant-design/icons'; 2 | import classNames from 'classnames'; 3 | import { FC, MouseEvent, PropsWithChildren, ReactNode, useEffect, useState } from 'react'; 4 | import { MessageItem } from './constants'; 5 | import Loading from './Loading'; 6 | import { isEmpty, isString } from 'lodash'; 7 | import { Collapse, Space, Tooltip } from 'antd'; 8 | 9 | const { Panel } = Collapse; 10 | 11 | interface MessageProps extends PropsWithChildren { 12 | isQuestion?: boolean; 13 | loading?: boolean; 14 | text: ReactNode; 15 | item?: MessageItem; 16 | chunkIdList?: number[]; 17 | error?: boolean; 18 | onSourceClick?: (data: any) => void; 19 | } 20 | 21 | const Message: FC = ({ 22 | text = '', 23 | isQuestion, 24 | item, 25 | loading, 26 | error, 27 | onSourceClick 28 | }) => { 29 | const [words, setWords] = useState([]); 30 | const [showSources, setShowSources] = useState(false); 31 | 32 | useEffect(() => { 33 | if (!error && isString(text)) { 34 | setWords(text.split(' ')); 35 | } 36 | }, [text]); 37 | 38 | if (loading) { 39 | return ; 40 | } 41 | 42 | function handleSourceClick(e: MouseEvent, item: any) { 43 | e.stopPropagation(); 44 | onSourceClick?.(item); 45 | } 46 | 47 | function toggleShowSource() { 48 | setShowSources(!showSources); 49 | } 50 | 51 | return ( 52 |
58 |
63 | 64 | {isQuestion ? 'You' : 'AI'} 65 | 66 | {item?.cost && ( 67 | 68 | 69 | cost 70 | 71 | 72 | )} 73 | 74 | 75 | {!isEmpty(item?.sources) && ( 76 |
80 | {showSources ? 'Hide Sources' : 'Show Source'} 81 |
82 | )} 83 |
84 | 85 | {showSources && ( 86 | 87 | {item?.sources?.map((item, index) => ( 88 | handleSourceClick(e, item)} 95 | /> 96 | } 97 | > 98 | {item.text} 99 | 100 | ))} 101 | 102 | )} 103 | 104 |
110 | {isQuestion ? ( 111 |
{text}
112 | ) : ( 113 |
114 | {error && text} 115 | {words.map((word, index) => ( 116 | {word} 117 | ))} 118 |
119 | )} 120 |
121 |
122 | ); 123 | }; 124 | 125 | export default Message; 126 | -------------------------------------------------------------------------------- /client/src/assets/react.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DocsMind 2 | 3 | DocsMind is an open-source project that allows you to chat with your docs. 4 | 5 | ![Stack](https://skillicons.dev/icons?i=vite,react,ts,tailwind,flask) 6 | 7 | It is currently under development and there may be major changes at any time. 8 | 9 | ## 🎬 Demo 10 | 11 | [Demo Site](https://docs-mind.alanwang.site/) 12 | 13 | > **Warning** 14 | > 15 | > Due to the free plan of Railway only providing 500 hours per month, the Demo on the 21st day of each month will not be available. Please clone it locally for use at that time. 16 | 17 | ## 🌟 Features 18 | 19 | - 🤖 Ask a question with your docs 20 | - 📝 Summarize docs 21 | - 🖍️ Highlight source 22 | - 📤 Upload docs .pdf,.md(best support) 23 | - 💾 Data saved locally 24 | - 💰 Token usage tracker 25 | - 🐳 Dockerize 26 | 27 | ## 🚀 Road Map 28 | 29 | - [ ] Chat mode 30 | - [ ] Dark mode 31 | - [ ] / command (/fetch /summarize) 32 | - [ ] Reduce the size of the server image. 33 | - [ ] Support for more docs formats: txt... 34 | - [ ] Download docs from the internet 35 | - [ ] Markdown-formatted message 36 | - [ ] i18n 37 | - [ ] Desktop application 38 | 39 | If you find this project helpful, please consider giving it a star 🌟 40 | 41 | ## 💻 Environment Variables 42 | 43 | | Name | Description | Optional | 44 | | -------------------- | -------------------------------------- | -------- | 45 | | OPENAI_PROXY | will replace https://api.openai.com/v1 | ✅ | 46 | | VITE_SERVICES_URL | backend url for frontend code | ✅ | 47 | | VITE_DISABLED_UPLOAD | DISABLED_UPLOAD | ✅ | 48 | 49 | ## ❓ FAQ 50 | 51 | This project includes both frontend (/client) and backend (/server) code. The frontend code is used to display the UI, while the backend code provides services to the UI. 52 | 53 | ### How to deploy? 54 | 55 | [More details](https://github.com/3Alan/DocsMind/blob/main/Deployment.md) 56 | 57 | ### How to run? 58 | 59 | > **Warning** 60 | > 61 | > Please check if you can access OpenAI in your region, you can refer to the [issue](https://github.com/3Alan/DocsMind/issues/3#issuecomment-1511470063) for more information. 62 | 63 | 1. Create .env 64 | 65 | Create a `.env` file and copy the contents of `.env.example` to modify it. 66 | 67 | 2. Run App 68 | 69 | ```bash 70 | docker-compose up -d 71 | ``` 72 | 73 | Please add `--build` to rebuild the image after each code update. 74 | 75 | ```bash 76 | docker-compose up -d --build 77 | ``` 78 | 79 | now you can access the app at `http://localhost:8081` 80 | 81 | All data will be saved in the `./data` directory. 82 | 83 | ### Local Development 84 | 85 |
86 | Detail 87 | 88 | #### Create .env 89 | 90 | Create a `.env` file and copy the contents of `.env.example` to modify it. 91 | 92 | #### Run Frontend UI 93 | 94 | 1. Install dependencies 95 | 96 | ``` 97 | yarn 98 | ``` 99 | 100 | 2. Run app 101 | 102 | ``` 103 | yarn dev 104 | ``` 105 | 106 | #### Run Backend Services 107 | 108 | you need a python environment 109 | 110 | 1. Create virtual environment 111 | 112 | ``` 113 | cd server 114 | python -m venv .venv 115 | ``` 116 | 117 | 2. Active virtual environment 118 | 119 | windows 120 | 121 | ``` 122 | .venv\Scripts\activate 123 | ``` 124 | 125 | mac 126 | 127 | ``` 128 | . .venv/bin/activate 129 | ``` 130 | 131 | 3. Install dependencies 132 | 133 | ``` 134 | pip install -r requirements.txt 135 | ``` 136 | 137 | 4. Run Services 138 | 139 | ``` 140 | flask run --reload --port=8080 141 | ``` 142 | 143 |
144 | 145 | ## 📝 License 146 | 147 | [AGPL-3.0 License](https://github.com/3Alan/DocsMind/blob/main/LICENSE) 148 | 149 | ## ☕ Buy me a coffee 150 | 151 | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/N4N1L5Y7V) 152 | 153 |
154 | Alipay and Wechat 155 | 156 |
157 | -------------------------------------------------------------------------------- /server/custom_loader.py: -------------------------------------------------------------------------------- 1 | from typing import Any, List 2 | 3 | import tiktoken 4 | from bs4 import BeautifulSoup 5 | from llama_index.readers.base import BaseReader 6 | from llama_index.readers.schema.base import Document 7 | 8 | staticPath = "static" 9 | 10 | 11 | def encode_string(string: str, encoding_name: str = "p50k_base"): 12 | encoding = tiktoken.get_encoding(encoding_name) 13 | return encoding.encode(string) 14 | 15 | 16 | def decode_string(token: str, encoding_name: str = "p50k_base"): 17 | encoding = tiktoken.get_encoding(encoding_name) 18 | return encoding.decode(token) 19 | 20 | 21 | def num_tokens_from_string(string: str, encoding_name: str = "p50k_base") -> int: 22 | """Returns the number of tokens in a text string.""" 23 | encoding = tiktoken.get_encoding(encoding_name) 24 | num_tokens = len(encoding.encode(string)) 25 | return num_tokens 26 | 27 | 28 | def split_text_to_doc( 29 | text: str, current_chunk_id, chunk_size: int = 400 30 | ) -> List[Document]: 31 | """Split text into chunks of a given size.""" 32 | chunks = [] 33 | token_len = num_tokens_from_string(text) 34 | 35 | for i in range(0, token_len, chunk_size): 36 | encode_text = encode_string(text) 37 | decode_text = decode_string(encode_text[i : i + chunk_size]).strip() 38 | chunks.append( 39 | Document( 40 | decode_text, 41 | extra_info={"chunk_id": f"chunk-{current_chunk_id}"}, 42 | ) 43 | ) 44 | 45 | return chunks 46 | 47 | 48 | class CustomReader(BaseReader): 49 | def __init__(self, *args: Any, **kwargs: Any) -> None: 50 | """Init params.""" 51 | super().__init__(*args, **kwargs) 52 | 53 | def load_data(self, html, filename) -> List[Document]: 54 | soup = BeautifulSoup(html, "html.parser") 55 | current_chunk_text = "" 56 | current_chunk_id = 1 57 | document_list = [] 58 | # 单位是token，openai限制4097，如果实现连续对话大概可以进行6轮对话 59 | current_chunk_length = 0 60 | chunk_size = 400 61 | 62 | # 只处理前三级标题，其他的按照段落处理 63 | headings = ["h1", "h2", "h3"] 64 | heading_doms = soup.find_all(headings) 65 | 66 | if len(heading_doms) == 0: 67 | heading_doms = [soup.find()] 68 | 69 | for tag in heading_doms: 70 | tag["data-chunk_id"] = f"chunk-{current_chunk_id}" 71 | current_chunk_text = tag.text.strip() 72 | 73 | # 遍历所有兄弟节点，不递归遍历子节点 74 | next_tag = tag.find_next_sibling() 75 | while next_tag and next_tag.name not in headings: 76 | stripped_text = next_tag.text.strip() 77 | 78 | if ( 79 | current_chunk_length + num_tokens_from_string(stripped_text) 80 | > chunk_size 81 | ): 82 | document_list.append( 83 | Document( 84 | current_chunk_text.strip(), 85 | extra_info={"chunk_id": f"chunk-{current_chunk_id}"}, 86 | ) 87 | ) 88 | current_chunk_text = "" 89 | current_chunk_length = 0 90 | current_chunk_id += 1 91 | 92 | document_list += split_text_to_doc(stripped_text, current_chunk_id) 93 | 94 | else: 95 | current_chunk_text = f"{current_chunk_text} {stripped_text}" 96 | current_chunk_length += num_tokens_from_string(stripped_text) + 1 97 | 98 | next_tag["data-chunk_id"] = f"chunk-{current_chunk_id}" 99 | next_tag = next_tag.find_next_sibling() 100 | 101 | document_list.append( 102 | Document( 103 | current_chunk_text.strip(), 104 | extra_info={"chunk_id": f"chunk-{current_chunk_id}"}, 105 | ) 106 | ) 107 | current_chunk_text = "" 108 | current_chunk_length = 0 109 | current_chunk_id += 1 110 | 111 | # 保存修改后的HTML文件 112 | with open(f"{staticPath}/file/{filename}.html", "w", encoding="utf-8") as f: 113 | f.write(str(soup)) 114 | 115 | return document_list 116 | -------------------------------------------------------------------------------- /server/static/file/AA-README.html: -------------------------------------------------------------------------------- 1 |

DocsMind

2 |

DocsMind is an open-source project that allows you to chat with your docs.

3 |

Stack

4 |

Demo

5 |

Demo Site

6 |
7 |

Warning

8 |

Due to the free plan of Railway only providing 500 hours per month, the Demo on the 21st day of each month will not be available. Please clone it locally for use at that time.

9 |
10 |

Features

11 |
    12 |
  • 🤖 Ask a question with your docs
    • 13 |
  • 📝 Summarize docs
    • 14 |
  • 🖍️ Highlight source
    • 15 |
  • 📤 Upload docs .pdf,.md(best support)
    • 16 |
  • 💾 Data saved locally
    • 17 |
  • 💰 Token usage tracker
    • 18 |
  • 🐳 Dockerize
    • 19 |
20 |

Future Development

21 |
    22 |
  • [ ] Chat mode
    • 23 |
  • [ ] Dark mode
    • 24 |
  • [ ] / command (/fetch /summarize)
    • 25 |
  • [ ] Reduce the size of the server image.
    • 26 |
  • [ ] Support for more docs formats: txt...
    • 27 |
  • [ ] Download docs from the internet
    • 28 |
  • [ ] Markdown-formatted message
    • 29 |
  • [ ] i18n
    • 30 |
  • [ ] Desktop application
    • 31 |
32 |

If you find this project helpful, please consider giving it a star 🌟

33 |

Environment Variables

34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 |
NameDescriptionOptional
OPENAI_PROXYwill replace https://api.openai.com/v1✅
VITE_SERVICES_URLbackend url for frontend code✅
VITE_DISABLED_UPLOADDISABLED_UPLOAD✅
60 |

Q&A

61 |

This project includes both front-end (/client) and back-end (/server) code. The front-end code is used to display the UI, while the back-end code provides services to the UI.

62 |

How to deploy?

63 |

You need to deploy this project using Docker Compose.

64 |

Can I deploy on Vercel?

65 |

No, Vercel is a serverless platform where you can only deploy your UI code (/client).

66 |

How to run?

67 |
68 |

Warning

69 |

Please check if you can access OpenAI in your region, you can refer to the issue for more information.

70 |
71 |
    72 |
  1. Create .env
    2. 73 |
74 |

Create a .env file and copy the contents of .env.example to modify it.

75 |
    76 |
  1. Run App
    2. 77 |
78 | 
docker-compose up -d
 79 |
80 |

Please add --build to rebuild the image after each code update.

81 | 
docker-compose up -d --build
 82 |
83 |

now you can access the app at http://localhost:8081

84 |

Local Development

85 |
86 | Detail 87 | 88 | #### Create .env 89 | 90 | Create a `.env` file and copy the contents of `.env.example` to modify it. 91 | 92 | #### Run Frontend UI 93 | 94 | 1. Install dependencies 95 | 96 | 
yarn
 97 |
98 | 99 | 2. Run app 100 | 101 | 
yarn dev
102 |
103 | 104 | #### Run Backend Services 105 | 106 | you need a python environment 107 | 108 | 1. Create virtual environment 109 | 110 | 
cd server
111 | python -m venv .venv
112 |
113 | 114 | 2. Active virtual environment 115 | 116 | windows 117 | 118 | 
.venv\Scripts\activate
119 |
120 | 121 | mac 122 | 123 | 
. .venv/bin/activate
124 |
125 | 126 | 3. Install dependencies 127 | 128 | 
pip install -r requirements.txt
129 |
130 | 131 | 4. Run Services 132 | 133 | 
flask run --reload --port=8080
134 |
135 |
136 |

License

137 |

AGPL-3.0 License

138 |

Buy me a coffee

139 |
140 | QR code 141 | 142 |
-------------------------------------------------------------------------------- /server/app.py: -------------------------------------------------------------------------------- 1 | import json 2 | import logging 3 | import os 4 | from pathlib import Path 5 | 6 | import openai 7 | from create_index import create_index 8 | from dotenv import load_dotenv 9 | from flask import Flask, Response, jsonify, request, stream_with_context 10 | from flask_cors import CORS 11 | from llama_index import ( 12 | GPTListIndex, 13 | GPTSimpleVectorIndex, 14 | MockEmbedding, 15 | MockLLMPredictor, 16 | ServiceContext, 17 | download_loader, 18 | ) 19 | from llama_index.optimization.optimizer import SentenceEmbeddingOptimizer 20 | 21 | openai_proxy = os.environ.get("OPENAI_PROXY", "https://api.openai.com/v1") 22 | openai.api_base = openai_proxy 23 | 24 | 25 | staticPath = "static" 26 | 27 | if not os.path.exists(f"{staticPath}/file"): 28 | os.makedirs(f"{staticPath}/file") 29 | if not os.path.exists(f"{staticPath}/index"): 30 | os.makedirs(f"{staticPath}/index") 31 | if not os.path.exists(f"{staticPath}/temp"): 32 | os.makedirs(f"{staticPath}/temp") 33 | if not os.path.exists(f"logs"): 34 | os.makedirs(f"logs") 35 | 36 | 37 | app = Flask(__name__, static_folder=f"{staticPath}") 38 | 39 | 40 | CORS(app) 41 | 42 | logger = logging.getLogger(__name__) 43 | file_handler = logging.FileHandler("logs/app.log", encoding="utf-8") 44 | formatter = logging.Formatter( 45 | "%(asctime)s %(levelname)s: %(message)s", datefmt="%Y-%m-%d %H:%M:%S" 46 | ) 47 | file_handler.setFormatter(formatter) 48 | file_handler.setLevel(logging.ERROR) 49 | logger.addHandler(file_handler) 50 | 51 | load_dotenv() 52 | 53 | 54 | @app.errorhandler(Exception) 55 | def handle_error(error): 56 | """全局错误处理""" 57 | message = str(error) 58 | status_code = 500 59 | if hasattr(error, "status_code"): 60 | status_code = error.status_code 61 | print("some error:", error) 62 | response = jsonify({"message": message}) 63 | response.status_code = status_code 64 | logger.error(error, exc_info=True) 65 | return response 66 | 67 | 68 | @app.route("/api/summarize", methods=["GET"]) 69 | def summarize_index(): 70 | file = request.args.get("file") 71 | open_ai_key = request.args.get("openAiKey") 72 | if open_ai_key: 73 | os.environ["OPENAI_API_KEY"] = open_ai_key 74 | 75 | UnstructuredReader = download_loader("UnstructuredReader") 76 | loader = UnstructuredReader() 77 | documents = loader.load_data(file=Path(f"./{staticPath}/file/{file}")) 78 | index = GPTListIndex.from_documents(documents) 79 | 80 | # predictor cost 81 | llm_predictor = MockLLMPredictor(max_tokens=256) 82 | embed_model = MockEmbedding(embed_dim=1536) 83 | service_context = ServiceContext.from_defaults( 84 | llm_predictor=llm_predictor, embed_model=embed_model 85 | ) 86 | 87 | # TODO: Format everything as markdown 88 | prompt = f""" 89 | Summarize this document and provide three questions related to the summary. Try to use your own words when possible. Keep your answer under 5 sentences. 90 | 91 | Use the following format: 92 | 93 | 94 | 95 | Questions you may want to ask 🤔 96 | 1. 97 | 2. 98 | 3. 99 | """ 100 | 101 | index.query( 102 | prompt, 103 | response_mode="tree_summarize", 104 | service_context=service_context, 105 | optimizer=SentenceEmbeddingOptimizer(percentile_cutoff=0.8), 106 | ) 107 | 108 | res = index.query( 109 | prompt, 110 | streaming=True, 111 | response_mode="tree_summarize", 112 | optimizer=SentenceEmbeddingOptimizer(percentile_cutoff=0.8), 113 | ) 114 | cost = embed_model.last_token_usage + llm_predictor.last_token_usage 115 | 116 | def response_generator(): 117 | yield json.dumps({"cost": cost, "sources": []}) 118 | yield "\n ###endjson### \n\n" 119 | for text in res.response_gen: 120 | yield text 121 | 122 | # 用完了就删掉，防止key被反复使用 123 | if open_ai_key: 124 | os.environ["OPENAI_API_KEY"] = "" 125 | 126 | return Response(stream_with_context(response_generator())) 127 | 128 | 129 | @app.route("/api/query", methods=["GET"]) 130 | def query_index(): 131 | query_text = request.args.get("query") 132 | index_name = request.args.get("index") 133 | open_ai_key = request.args.get("openAiKey") 134 | if open_ai_key: 135 | os.environ["OPENAI_API_KEY"] = open_ai_key 136 | 137 | index = GPTSimpleVectorIndex.load_from_disk(f"{staticPath}/index/{index_name}.json") 138 | 139 | # predictor cost 140 | llm_predictor = MockLLMPredictor(max_tokens=256) 141 | embed_model = MockEmbedding(embed_dim=1536) 142 | service_context = ServiceContext.from_defaults( 143 | llm_predictor=llm_predictor, embed_model=embed_model 144 | ) 145 | # 不支持 streaming，所以需要另外执行 146 | index.query(query_text, service_context=service_context) 147 | 148 | res = index.query(query_text, streaming=True) 149 | cost = embed_model.last_token_usage + llm_predictor.last_token_usage 150 | sources = [ 151 | {"extraInfo": x.node.extra_info, "text": x.node.text} for x in res.source_nodes 152 | ] 153 | 154 | def response_generator(): 155 | yield json.dumps({"cost": cost, "sources": sources}) 156 | yield "\n ###endjson### \n\n" 157 | for text in res.response_gen: 158 | yield text 159 | 160 | # 用完了就删掉，防止key被反复使用 161 | if open_ai_key: 162 | os.environ["OPENAI_API_KEY"] = "" 163 | 164 | return Response(stream_with_context(response_generator())) 165 | 166 | 167 | @app.route("/api/upload", methods=["POST"]) 168 | def upload_file(): 169 | filepath = None 170 | try: 171 | open_ai_key = request.form["openAiKey"] 172 | if open_ai_key: 173 | os.environ["OPENAI_API_KEY"] = open_ai_key 174 | 175 | uploaded_file = request.files["file"] 176 | filename = uploaded_file.filename 177 | print(os.getcwd(), os.path.abspath(__file__)) 178 | filepath = os.path.join(f"{staticPath}/temp", os.path.basename(filename)) 179 | uploaded_file.save(filepath) 180 | 181 | token_usage = create_index(filepath, filename) 182 | except Exception as e: 183 | logger.error(e, exc_info=True) 184 | # cleanup temp file 185 | print(e, "upload error") 186 | if filepath is not None and os.path.exists(filepath): 187 | os.remove(filepath) 188 | 189 | # 用完了就删掉，防止key被反复使用 190 | if open_ai_key: 191 | os.environ["OPENAI_API_KEY"] = "" 192 | return "Error: {}".format(str(e)), 500 193 | 194 | # cleanup temp file 195 | if filepath is not None and os.path.exists(filepath): 196 | os.remove(filepath) 197 | 198 | # 用完了就删掉，防止key被反复使用 199 | if open_ai_key: 200 | os.environ["OPENAI_API_KEY"] = "" 201 | 202 | return jsonify(token_usage), 200 203 | 204 | 205 | @app.route("/api/index-list", methods=["GET"]) 206 | def get_index_files(): 207 | dir = f"{staticPath}/index" 208 | files = os.listdir(dir) 209 | return files 210 | 211 | 212 | @app.route("/api/file-list", methods=["GET"]) 213 | def get_html_files(): 214 | dir = f"{staticPath}/file" 215 | files = os.listdir(dir) 216 | file_list = [ 217 | { 218 | "path": f"/{dir}/{file}", 219 | "name": os.path.splitext(file)[0], 220 | "ext": os.path.splitext(file)[1], 221 | "fullName": file, 222 | } 223 | for file in files 224 | ] 225 | 226 | return sorted(file_list, key=lambda x: x["name"].lower()) 227 | 228 | 229 | if __name__ == "__main__": 230 | app.run() 231 | -------------------------------------------------------------------------------- /client/src/components/chatWindow/index.tsx: -------------------------------------------------------------------------------- 1 | import { ProfileOutlined, SendOutlined, WarningTwoTone } from '@ant-design/icons'; 2 | import { Button, Card, Input, message, Popconfirm, Tooltip } from 'antd'; 3 | import classNames from 'classnames'; 4 | import { isEmpty } from 'lodash'; 5 | import { FC, Fragment, KeyboardEvent, useEffect, useLayoutEffect, useRef, useState } from 'react'; 6 | import eventEmitter from '../../utils/eventEmitter'; 7 | import fetchRequest from '../../utils/fetch'; 8 | import useOpenAiKey from '../../utils/useOpenAiKey'; 9 | import { MessageItem } from './constants'; 10 | import Message from './Message'; 11 | 12 | interface ChatWindowProps { 13 | fileName: string; 14 | fullFileName: string; 15 | className?: string; 16 | onReplyComplete: (data: any) => void; 17 | onSourceClick: (data: any) => void; 18 | } 19 | 20 | const ChatWindow: FC = ({ 21 | fileName, 22 | fullFileName, 23 | className, 24 | onReplyComplete, 25 | onSourceClick 26 | }) => { 27 | const chatWindowRef = useRef(null); 28 | const [loading, setLoading] = useState(false); 29 | const [query, setQuery] = useState(''); 30 | const [messageList, setMessageList] = useState([]); 31 | const openAiKey = useOpenAiKey(); 32 | 33 | function cleanChat() { 34 | setMessageList([]); 35 | } 36 | 37 | useEffect(() => { 38 | eventEmitter.on('cleanChat', cleanChat); 39 | 40 | return () => { 41 | eventEmitter.off('cleanChat', cleanChat); 42 | }; 43 | }, []); 44 | 45 | useLayoutEffect(() => { 46 | requestAnimationFrame(() => scrollToBottom()); 47 | }, [messageList]); 48 | 49 | const scrollToBottom = () => { 50 | const chatWindow = chatWindowRef.current; 51 | chatWindow && (chatWindow.scrollTop = chatWindow?.scrollHeight || 0); 52 | }; 53 | 54 | const updateMessageList = (message: string) => { 55 | setMessageList((pre) => { 56 | return [ 57 | ...pre.slice(0, -1), 58 | { 59 | ...pre.slice(-1)[0], 60 | reply: pre.slice(-1)[0].reply + message 61 | } 62 | ]; 63 | }); 64 | }; 65 | 66 | const onReply = async (value: string, summarize = false) => { 67 | try { 68 | let res: Response; 69 | setLoading(true); 70 | 71 | if (summarize) { 72 | res = await fetchRequest('/api/summarize', { 73 | file: fullFileName, 74 | openAiKey 75 | }); 76 | } else { 77 | res = await fetchRequest('/api/query', { 78 | query: value, 79 | index: fileName, 80 | openAiKey 81 | }); 82 | } 83 | 84 | setLoading(false); 85 | 86 | const reader = res?.body?.getReader() as ReadableStreamDefaultReader; 87 | 88 | const decoder = new TextDecoder(); 89 | let done = false; 90 | let metaData: any; 91 | 92 | while (!done) { 93 | const { value, done: doneReading } = await reader.read(); 94 | 95 | done = doneReading; 96 | const chunkValue = decoder.decode(value); 97 | const hasMeta = chunkValue.includes('\n ###endjson### \n\n'); 98 | if (hasMeta) { 99 | const [metaDataStr, message] = chunkValue.split('\n ###endjson### \n\n'); 100 | metaData = JSON.parse(metaDataStr); 101 | 102 | updateMessageList(message.trim()); 103 | } else { 104 | updateMessageList(chunkValue); 105 | } 106 | } 107 | 108 | setMessageList((pre) => { 109 | return [ 110 | ...pre.slice(0, -1), 111 | { 112 | ...pre.slice(-1)[0], 113 | cost: metaData.cost, 114 | sources: metaData.sources 115 | } 116 | ]; 117 | }); 118 | 119 | onReplyComplete({ ...metaData?.sources[0] }); 120 | } catch (error) { 121 | setLoading(false); 122 | setMessageList((pre) => { 123 | return [ 124 | ...pre.slice(0, -1), 125 | { 126 | ...pre.slice(-1), 127 | reply: ( 128 | <> 129 | please retry 130 | 131 | ), 132 | error: true 133 | } 134 | ]; 135 | }); 136 | console.log(error); 137 | } 138 | }; 139 | 140 | const onSearch = async () => { 141 | if (!openAiKey) { 142 | message.error('Please set your openAI key'); 143 | return; 144 | } 145 | 146 | setQuery(''); 147 | setMessageList([...messageList, { question: query }, { reply: '' }]); 148 | onReply(query); 149 | }; 150 | 151 | const onKeyDown = (e: KeyboardEvent) => { 152 | if (e.shiftKey) return; 153 | 154 | if (e.key === 'Enter') { 155 | e.preventDefault(); 156 | onSearch(); 157 | } 158 | }; 159 | 160 | const onSummarize = async () => { 161 | setMessageList([...messageList, { question: 'Summarize the Document' }, { reply: '' }]); 162 | onReply('', true); 163 | }; 164 | 165 | const onSummarizeClick = () => { 166 | if (!isEmpty(fileName)) { 167 | onSummarize(); 168 | } 169 | }; 170 | 171 | return ( 172 | 192 | 193 | 194 | 195 | 196 | } 197 | bordered={false} 198 | > 199 |
200 | {messageList.map((item, index) => ( 201 | 202 | {item.question ? ( 203 | 204 | ) : ( 205 | 212 | )} 213 | 214 | ))} 215 |
216 | 217 |
218 |
219 | setQuery(e.target.value)} 228 | /> 229 | 237 |
238 |
239 | 240 | ); 241 | }; 242 | 243 | export default ChatWindow; 244 | -------------------------------------------------------------------------------- /server/static/testFiles/TypeScript入门学习总结.md: -------------------------------------------------------------------------------- 1 | TypeScript 常用知识点总结 2 | 3 | > [TypeScript 中文手册](https://typescript.bootcss.com/basic-types.html) 4 | > 5 | > [TypeScript－系统入门到项目实战](https://coding.imooc.com/class/412.html) 6 | 7 | 8 | 9 | ## 什么是 TypeScript 10 | 11 | TypeScript 是 JavaScript 的一个超集，在 JavaScript 的基础上增加了可选的**静态类型**和基于类的面向对象编程。它可以编译成纯 JavaScript，未编译的 ts 代码无法在浏览器执行。我们可以把它和 JavaScript 的关系理解成 css 和 less、sass 的关系。 12 | 13 | ## TypeScript 好在哪里 14 | 15 | - TS 可以进行动态类型检测，可以检测出一些潜在的 bug（例如拼写错误、参数缺失、undefined 等），提升代码健壮性 16 | - 使用 vscode 进行开发可以很好的提示代码，提高开发效率 17 | - 代码可读性好 18 | 19 | ## 创建第一个 TypeScript 文件 20 | 21 | 首先安装 TypeScript 22 | 23 | ``` 24 | npm install -g typescript 25 | ``` 26 | 27 | 安装后看是否成功 28 | 29 | ``` 30 | tsc --version 31 | ``` 32 | 33 | 我安装后出现了以下问题： 34 | ![image-20200614175730166](https://raw.githubusercontent.com/3Alan/images/master/img/image-20200614175730166.png) 35 | 这种情况只需要以管理员的身份打开命令行运行以下命令： 36 | 37 | ``` 38 | set-ExecutionPolicy RemoteSigned 39 | ``` 40 | 41 | 创建第一个 ts 文件`Hello.ts` 42 | 43 | ```tsx 44 | function sayHello(name: String) { 45 | console.log(`Hello ${name}`); 46 | } 47 | let person = 'Alan'; 48 | sayHello(person); 49 | ``` 50 | 51 | 我们发现 ts 代码和普通的 js 代码在 `sayHello` 函数的参数上有所不同。 52 | `sayHello(name: String)` 53 | 大致的意思就是 `sayHello` 传入一个名为 name 的参数，该参数的类型必须是 `String` ，不然无法通过 ts 的编译。 54 | 代码写好后用 tsc 编译上面的 `Hello.ts` 文件 55 | 56 | ``` 57 | tsc Hello.ts 58 | ``` 59 | 60 | 编译成功后在同级目录下生成一个 `Hello.js` 文件，可以看到生成的 js 文件只是将 es6 语法转化成了 es5 语法，并没有改变其他代码。 61 | 62 | ```js 63 | function sayHello(name) { 64 | console.log('Hello ' + name); 65 | } 66 | var person = 'Alan'; 67 | sayHello(person); 68 | ``` 69 | 70 | 如果把`Hello.ts`文件改写一下 71 | 72 | ```tsx 73 | function sayHello(name: String) { 74 | const text = 3 + name; 75 | console.log(`Hello ${name}`); 76 | } 77 | let person = 123; 78 | sayHello(person); 79 | ``` 80 | 81 | 再次编译发现会报错但是仍然能生成 js 文件： 82 | ![image-20200614180440953](https://raw.githubusercontent.com/3Alan/images/master/img/image-20200614180440953.png) 83 | 84 | 上面错误的具体意思是 85 | 86 | - 由于声明了函数形参 `name` 为静态类型 `string` ，而在调用时传入得是 `number` 类型 `123` ，与前面的 `string` 不符。 87 | - 在 `sayHello` 函数中将 `name(string)` 和 `3(number)` 两种不同类型得值进行了相加。 88 | 89 | 我们发现每次都要通过 tsc 来编译 ts 文件能得到 js 文件后再去运行 js 文件，过于麻烦。可以使用插件 `ts-node` 来直接运行 ts 文件。 90 | 91 | ``` 92 | npm i ts-node -g 93 | ``` 94 | 95 | ``` 96 | ts-node Hello.ts 97 | ``` 98 | 99 | :::info 100 | 101 | ts 能够尝试分析变量类型（类型推断），ts 无法分析出的变量最好显式声明变量类型（类型注解） 102 | 103 | ::: 104 | 105 | ## 基础类型 106 | 107 | 变量的声明：`let [变量名] : [类型] = 值` 108 | 109 | 例如： `let age: number = 21` 110 | 111 | TypeScript 支持与 JavaScript 几乎相同的数据类型 112 | 113 | - boolean(布尔值) 114 | - number(数值) 115 | - string(字符串) 116 | - []/Array<元素类型>(数组) 117 | - 元组 Tuple 118 | - enum(枚举) 119 | - any(任何值) 120 | - void(空值) 121 | - null 122 | - undefined 123 | - never 124 | 125 | ## 数组 126 | 127 | 有 2 种方式定义数组 128 | 129 | ```tsx 130 | let arr: number[] = [1, 2, 3]; // 元素类型后接上`[]` 131 | let arr: Array = [1, 2, 3]; // 数组泛型 132 | let arr: (number | string)[] = [1, '2', '4']; // 元素类型可以是number或string（类似元组） 133 | ``` 134 | 135 | ## 元组 tuple 136 | 137 | 表示一个数组（各个元素的类型不必相同） 138 | 139 | ```tsx 140 | let list: [string, number]; //第一个元素为string类型，第二个为number类型 141 | a = ['abc', 123]; //合格 142 | b = [123, 'abc']; //不合格 143 | ``` 144 | 145 | ## 枚举 146 | 147 | 其实有点类似对象 148 | 看例子吧 149 | 150 | ```tsx 151 | enum lan {js, ts, css}; 152 | console.log(lan.js); // 0 js对应的下标，第一个默认下标为0 153 | 154 | enum lan { 155 | js = 3, 156 | ts, 157 | css, 158 | } 159 | console.log(lan.js); // 3 160 | console.log(lan.ts); // 4 161 | console.log(lan.css); // 5 162 | 163 | enum lan { 164 | js, 165 | ts = 3, 166 | css, 167 | } 168 | console.log(lan.js); // 0 169 | console.log(lan.ts); // 3 170 | console.log(lan.css); // 4 171 | console.log(lan[4]); // css 172 | console.log(lan[1]); // undefined 173 | // 第一个默认下标为0，css接着ts的值+1 174 | 175 | enum lan {js = 'good', ts = 'nice', css = 'well'}; 176 | console.log(lan.js); // good 177 | 178 | // const枚举，为了避免在额外生成的代码上的开销和额外的非直接的对枚举成员的访问。 179 | const enum People { 180 | name: 'Alan', 181 | age: 23 182 | } 183 | 184 | // 编译时会自动转化成常量值，不会保留其他代码 185 | console.log(People.name); // Alan 186 | 187 | ``` 188 | 189 | ## any 190 | 191 | 顾名思义，任意值，当我们想为还不清楚类型的变量指定一个类型时， `any` 就是最好的选择 🤭 192 | 193 | ```tsx 194 | let a: any = 4; 195 | a = '123'; //合格 196 | 197 | let arr: any[] = [1, '123', true]; // 和元组很像 198 | arr[1] = 'good'; 199 | ``` 200 | 201 | ## void 202 | 203 | 常用于无返回值的函数声明 204 | 205 | ```tsx 206 | function func(): void { 207 | console.log('learning typescript...'); 208 | } 209 | func(); //合格 210 | 211 | function func(): void { 212 | return 1; 213 | } 214 | func(); // 不合格：Type '1' is not assignable to type 'void' 215 | ``` 216 | 217 | ## null 和 undefined 218 | 219 | 用处不大，默认情况下是所有类型的子类型，例如下面代码是没有问题的： 220 | 221 | ```tsx 222 | let a: string; 223 | a = undefined; 224 | a = null; 225 | ``` 226 | 227 | **但是**，当指定`--strictNullChecks`标记时，null 和 undefined 只能赋值给 void 和他们自己本身。 228 | 229 | ## never 230 | 231 | 表示永不存在的值的类型 232 | never 类型是那些总是会抛出异常或根本就不会有返回值的函数表达式或箭头函数表达式的返回值类型； 233 | 变量也可能是 never 类型，当它们被永不为真的类型保护所约束时。 234 | 235 | never 类型是任何类型的子类型，也可以赋值给任何类型；然而，没有类型是 never 的子类型或可以赋值给 never 类型（除了 never 本身之外）。 即使 any 也不可以赋值给 never。 236 | 237 | ```tsx 238 | function error(message: string): never { 239 | throw new Error(message); 240 | } 241 | 242 | // 返回never的函数必须存在无法达到的终点 243 | function infiniteLoop(): never { 244 | while (true) {} 245 | } 246 | ``` 247 | 248 | ## 结构赋值的写法 249 | 250 | ```tsx 251 | function sayAge({ name, age }: { name: string | number; age: number }): void { 252 | console.log(`${name} is ${age} years old`); 253 | } 254 | sayAge({ name: 'Alan', age: 22 }); 255 | sayAge({ name: 2, age: 22 }); 256 | ``` 257 | 258 | ## 联合类型 259 | 260 | 用 `|` 来表示取值存在多种可能 261 | 262 | ```tsx 263 | let a: string | number; 264 | a = 1; 265 | a = 'A'; 266 | ``` 267 | 268 | ## 类型断言 269 | 270 | 可以自己指定一个值的类型 271 | 格式如下 272 | `<类型>值` 273 | `值 as 类型` 274 | 275 | ```tsx 276 | interface student { 277 | isStudent: boolean; 278 | education: number; 279 | } 280 | interface worker { 281 | isStudent: boolean; 282 | seniority: number; 283 | } 284 | function Recruit(candidate: worker | student): void { 285 | if (candidate.isStudent) { 286 | console.log(`your education is ${(candidate as student).education}`); 287 | } else { 288 | console.log(`your seniority is ${(candidate as worker).seniority}`); 289 | } 290 | } 291 | 292 | const a: student = { isStudent: true, education: 4 }; 293 | const b: worker = { isStudent: false, seniority: 2 }; 294 | Recruit(a); 295 | Recruit(b); 296 | ``` 297 | 298 | 由于 `candidate` 使用了联合类型，所以 ts 无法判断 `candidate` 究竟是属于 `student` 还是 `worker` ，所以要使用类型断言来显式告诉 ts。 299 | 300 | 当然还有其他方式来实现 301 | 302 | ```tsx 303 | interface student { 304 | isStudent: boolean; 305 | education: number; 306 | } 307 | interface worker { 308 | isStudent: boolean; 309 | seniority: number; 310 | } 311 | function Recruit(candidate: worker | student): void { 312 | 'education' in candidate && console.log(`your education is ${candidate.education}`); 313 | 'seniority' in candidate && console.log(`your seniority is ${candidate.seniority}`); 314 | } 315 | 316 | const a: student = { isStudent: true, education: 4 }; 317 | const b: worker = { isStudent: false, seniority: 2 }; 318 | Recruit(a); 319 | Recruit(b); 320 | ``` 321 | 322 | - typeof 323 | - instanceof 324 | 325 | ## 非空断言 326 | 327 | `!.` 对应 `--strictNullChecks` 328 | 329 | ```ts 330 | interface person { 331 | name: string; 332 | } 333 | function work(personObj?: person) { 334 | // 由于 personObj 可能不传，所以 personObj 可能为 undefined，使用 !. 可以断言 personObj 不为空 335 | console.log(personObj!.name); 336 | } 337 | ``` 338 | 339 | ## 接口 interface 340 | 341 | 先看一个接口的例子 342 | 343 | ```tsx 344 | interface person { 345 | name: string; 346 | } 347 | function work(personObj: person) { 348 | console.log(personObj.name); 349 | } 350 | let person1 = { name: 'Alan', age: 21 }; 351 | work(person1); 352 | let person2 = { age: 21 }; 353 | work(person2); 354 | ``` 355 | 356 | ![image-20200615180720618](https://raw.githubusercontent.com/3Alan/images/master/img/image-20200615180720618.png) 357 | 358 | 定义接口的关键字是 `interface` 359 | 这个例子需要传入 work 的参数必须是一个带有 name(string)的对象，可以理解为我要招聘一个有名字的员工，没有名字的都不需要。当然我们的 person1 中还多了一个`age`属性，这并不会报错。可是当我们直接传递参数时是会出错的。 360 | 361 | ```js 362 | work({ name: 'Alan', age: 21 }); 363 | ``` 364 | 365 | 那如果我不确定要招聘的员工除了有姓名外还需要其他什么属性时，可以像下面一样重新定义接口就可以解决上面的问题了。 366 | 367 | ```tsx 368 | interface person { 369 | name: string; 370 | [propName: string]: any; 371 | } 372 | ``` 373 | 374 | ### 可选属性 375 | 376 | 那如果我的招聘条件是最好懂 typescript 的，这个时候 typescript 就是可有可无的（最好懂，嘿嘿 😜），那我们就要用到**可选属性**了 377 | `可选属性`在可选属性名后面加上一个`?` 378 | 379 | ```tsx 380 | interface person { 381 | name: string; 382 | ts?: boolean; 383 | } 384 | function Recruit(personObj: person): string { 385 | if (personObj.ts) { 386 | return `congratulations!${personObj.name}`; 387 | } else { 388 | return `sorry,${personObj.name}, we need a employee who know ts!`; 389 | } 390 | } 391 | let person1 = { name: 'Alan', age: 21, ts: true }; 392 | console.log(Recruit(person1)); 393 | let person2 = { name: 'Bob', age: 21 }; 394 | console.log(Recruit(person2)); 395 | ``` 396 | 397 | ### 只读属性 398 | 399 | 我们都知道人的名字都是不可以改变的（一般情况下），这个时候我们对 person 接口里面的 name 属性稍作修改，在属性名 name 前加上`readonly`。 400 | 401 | :::tip 402 | 403 | 当然也可以使用 setter/getter 来实现 404 | 405 | ::: 406 | 407 | ```tsx 408 | interface person { 409 | readonly name: string; 410 | ts?: boolean; 411 | } 412 | let person1: person = { name: 'Alan' }; 413 | person1.name = 'Bob'; // Cannot assign to 'name' because it is a read-only property. 414 | ``` 415 | 416 | **我们发现 readonly 和 const 的作用好像有点相似，那我们什么时候使用 readonly 什么时候使用 const 呢？** 417 | 变量---->const 418 | 属性---->readonly 419 | 420 | ### 函数类型的接口 421 | 422 | 接口除了可以描述带有属性的对象外，还可以描述函数类型 423 | 这里创建一个函数来检查你有没有打卡 😁 424 | 425 | ```tsx 426 | interface attendanceFunc { 427 | (name: string, startTime: number, endTime: number): boolean; 428 | } 429 | let checkAttendance: attendanceFunc; 430 | checkAttendance = function (name: string, startTime: number, endTime: number): boolean { 431 | let result = startTime < 9 && endTime > 18; 432 | return result; 433 | }; 434 | console.log(checkAttendance('Alan', 10, 19)); // false 435 | ``` 436 | 437 | 看一下接口的声明： 438 | 439 | ```tsx 440 | interface attendanceFunc { 441 | (name: string, startTime: number, endTime: number): boolean; 442 | } 443 | ``` 444 | 445 | `name,startTime,endTime` 放在 `()` 中代表函数的参数 446 | `:boolean` 表示函数的返回值类型 447 | 当然上面例子中的`checkAttendance`的形参以及函数的返回值来说可以不指定类型，因为 `checkAttendance` 复制给了 `attendanceFunc` 变量，类型检查器会自动(按照接口中参数的顺序)推断出参数以及返回值的类型，也就是说写成下面这样也是可以的。**函数中的参数名可以不和接口中的相同** 448 | 449 | ```tsx 450 | interface attendanceFunc { 451 | (name: string, startTime: number, endTime: number): boolean; 452 | } 453 | let checkAttendance: attendanceFunc; 454 | checkAttendance = function (n, startTime, endTime) { 455 | let result = startTime < 9 && endTime > 18; 456 | return result; 457 | }; 458 | console.log(checkAttendance('Alan', 10, 19)); // false 459 | ``` 460 | 461 | ### 接口的继承 462 | 463 | 一个接口可以继承 1 个或者多个接口： 464 | 继承使用关键词`extends` 465 | 466 | ```tsx 467 | interface person { 468 | name: string; 469 | } 470 | interface student { 471 | studentId: number; 472 | } 473 | interface seniorStudent extends person, student { 474 | grade: string; 475 | } 476 | let student1: seniorStudent = { name: 'Alan', studentId: 1, grade: 'one' }; 477 | console.log(student1); 478 | ``` 479 | 480 | ## 类 class 481 | 482 | TS 中的类和 ES6 中的类很相似，这里只介绍不同的地方 483 | 484 | ### 变量修饰符 485 | 486 | - public（默认） 487 | - private（私有，不能在声明它的类的外部访问） 488 | - protected（和 private 类似，不同的是 protected 声明的变量可以在派生类（即子类）中访问） 489 | 490 | ### 静态属性 static 491 | 492 | ```tsx 493 | class Person { 494 | static fingerNum = 5; 495 | } 496 | 497 | // 只能通过类来访问 498 | console.log(Person.fingerNum); 499 | // 不能通过实例访问 500 | console.log(new Person().fingerNum); 501 | ``` 502 | 503 | ```tsx 504 | // 单例模式创建唯一的实例 505 | class singleClass { 506 | private static instance: singleClass; 507 | private constructor(public name: string) {} 508 | 509 | static getInstance() { 510 | if (!this.instance) { 511 | this.instance = new singleClass('Alan'); 512 | } 513 | return this.instance; 514 | } 515 | } 516 | 517 | const class1 = singleClass.getInstance(); 518 | const class2 = singleClass.getInstance(); 519 | console.log(class1.name); // Alan 520 | console.log(class1 === class2); // true 521 | ``` 522 | 523 | ### 构造函数 524 | 525 | ```tsx 526 | class Person { 527 | constructor(name, mobile, sex) { 528 | this.name = name; 529 | this.mobile = mobile; 530 | this.sex = sex; 531 | } 532 | public name: string; 533 | private mobile: string; 534 | protected sex: string; 535 | } 536 | ``` 537 | 538 | 上面的代码可以简写成下面这样 539 | 540 | ```tsx 541 | class Person { 542 | constructor(name: string, private mobile: string, protected sex: string) {} 543 | } 544 | ``` 545 | 546 | ### 抽象类 547 | 548 | - 不能被实例化 549 | - 要使用的话要声明其派生类，并且重写其中的抽象方法 550 | 551 | ```tsx 552 | abstract class Animal { 553 | constructor(public name: string) {} 554 | sayHello() { 555 | console.log('hello'); 556 | } 557 | // 声明抽象方法 558 | abstract action(): void; 559 | } 560 | 561 | class Bird extends Animal { 562 | constructor(name) { 563 | super(name); 564 | } 565 | action() { 566 | console.log('jijiji'); 567 | } 568 | } 569 | 570 | const bird = new Bird('qc'); 571 | console.log(bird); 572 | // Bird { name: 'qc' } 573 | ``` 574 | 575 | ## 泛型 576 | 577 | > 泛型（Generics）是指在定义函数、接口或类的时候，**不预先指定**具体的类型，而在**使用的时候**再指定类型的一种特性。 578 | 579 | ### 函数用法：<泛型名> 580 | 581 | ```tsx 582 | function Recruit(name: string, props: T) { 583 | return name + props; 584 | } 585 | // 显式指定为T为number类型 586 | console.log(Recruit('Alan', 123)); // Alan123 587 | // TS自动推断为number类型，和上面效果一样 588 | console.log(Recruit('Alan', 123)); // Alan123 589 | console.log(Recruit('Alan', [1, 2, 3])); // Alan1,2,3 590 | ``` 591 | 592 | 也可以使用多个泛型名，下面的例子结合了接口来完成 593 | 594 | ```tsx 595 | interface Contact { 596 | mobile: string; 597 | } 598 | 599 | interface Address { 600 | province: string; 601 | } 602 | 603 | function Recruit(name: string, contact: C, address: A) { 604 | return `${name}'s mobile is ${contact.mobile}, live in ${address.province}`; 605 | } 606 | 607 | console.log(Recruit('Alan', { mobile: '666' }, { province: 'Shanghai' })); 608 | // Alan's mobile is 666, live in Shanghai 609 | ``` 610 | 611 | ### 类用法 612 | 613 | ```tsx 614 | interface employee { 615 | name: string; 616 | age: number; 617 | } 618 | 619 | class RecruitManager { 620 | constructor(private data: Array) {} 621 | select(age: number): T { 622 | return this.data.find((item) => item.age > age); 623 | } 624 | } 625 | 626 | const result = new RecruitManager([ 627 | { 628 | name: 'Alan', 629 | age: 22 630 | }, 631 | { 632 | name: 'Bob', 633 | age: 18 634 | } 635 | ]); 636 | console.log(result.select(20)); 637 | ``` 638 | 639 | ### 泛型约束 640 | 641 | 使用 extends 约束泛型 642 | 643 | ```tsx 644 | interface info { 645 | mobile: string; 646 | } 647 | 648 | // T泛型必须满足info 649 | function Recruit(name: string, props: T) { 650 | return name + props.mobile; 651 | } 652 | 653 | console.log(Recruit('Alan', { mobile: '1232910830' })); // Alan1232910830 654 | ``` 655 | 656 | ## React 相关 657 | 658 | ### class 组件动态设置 state 659 | 660 | ```ts 661 | this.setState({ 662 | [name]: value 663 | } as Pick); 664 | ``` 665 | -------------------------------------------------------------------------------- /server/static/file/TypeScript入门学习总结.html: -------------------------------------------------------------------------------- 1 |

TypeScript 常用知识点总结

2 |
3 |

TypeScript 中文手册

4 |

TypeScript－系统入门到项目实战

5 |
6 | 7 |

什么是 TypeScript

8 |

TypeScript 是 JavaScript 的一个超集，在 JavaScript 的基础上增加了可选的静态类型和基于类的面向对象编程。它可以编译成纯 JavaScript，未编译的 ts 代码无法在浏览器执行。我们可以把它和 JavaScript 的关系理解成 css 和 less、sass 的关系。

9 |

TypeScript 好在哪里

10 |
    11 |
  • TS 可以进行动态类型检测，可以检测出一些潜在的 bug（例如拼写错误、参数缺失、undefined 等），提升代码健壮性
    • 12 |
  • 使用 vscode 进行开发可以很好的提示代码，提高开发效率
    • 13 |
  • 代码可读性好
    • 14 |
15 |

创建第一个 TypeScript 文件

16 |

首先安装 TypeScript

17 | 
npm install -g typescript
 18 |
19 |

安装后看是否成功

20 | 
tsc --version
 21 |
22 |

我安装后出现了以下问题： 23 | image-20200614175730166 24 | 这种情况只需要以管理员的身份打开命令行运行以下命令：

25 | 
set-ExecutionPolicy RemoteSigned
 26 |
27 |

创建第一个 ts 文件Hello.ts

28 | 
function sayHello(name: String) {
 29 |   console.log(`Hello ${name}`);
 30 | }
 31 | let person = 'Alan';
 32 | sayHello(person);
 33 |
34 |

我们发现 ts 代码和普通的 js 代码在 sayHello 函数的参数上有所不同。 35 | sayHello(name: String) 36 | 大致的意思就是 sayHello 传入一个名为 name 的参数，该参数的类型必须是 String ，不然无法通过 ts 的编译。 37 | 代码写好后用 tsc 编译上面的 Hello.ts 文件

38 | 
tsc Hello.ts
 39 |
40 |

编译成功后在同级目录下生成一个 Hello.js 文件，可以看到生成的 js 文件只是将 es6 语法转化成了 es5 语法，并没有改变其他代码。

41 | 
function sayHello(name) {
 42 |   console.log('Hello ' + name);
 43 | }
 44 | var person = 'Alan';
 45 | sayHello(person);
 46 |
47 |

如果把Hello.ts文件改写一下

48 | 
function sayHello(name: String) {
 49 |   const text = 3 + name;
 50 |   console.log(`Hello ${name}`);
 51 | }
 52 | let person = 123;
 53 | sayHello(person);
 54 |
55 |

再次编译发现会报错但是仍然能生成 js 文件： 56 | image-20200614180440953

57 |

上面错误的具体意思是

58 |
    59 |
  • 由于声明了函数形参 name 为静态类型 string ，而在调用时传入得是 number 类型 123 ，与前面的 string 不符。
    • 60 |
  • 在 sayHello 函数中将 name(string) 和 3(number) 两种不同类型得值进行了相加。
    • 61 |
62 |

我们发现每次都要通过 tsc 来编译 ts 文件能得到 js 文件后再去运行 js 文件，过于麻烦。可以使用插件 ts-node 来直接运行 ts 文件。

63 | 
npm i ts-node -g
 64 |
65 | 
ts-node Hello.ts
 66 |
67 |

:::info

68 |

ts 能够尝试分析变量类型（类型推断），ts 无法分析出的变量最好显式声明变量类型（类型注解）

69 |

:::

70 |

基础类型

71 |

变量的声明：let [变量名] : [类型] = 值

72 |

例如： let age: number = 21

73 |

TypeScript 支持与 JavaScript 几乎相同的数据类型

74 |
    75 |
  • boolean(布尔值)
    • 76 |
  • number(数值)
    • 77 |
  • string(字符串)
    • 78 |
  • []/Array<元素类型>(数组)
    • 79 |
  • 元组 Tuple
    • 80 |
  • enum(枚举)
    • 81 |
  • any(任何值)
    • 82 |
  • void(空值)
    • 83 |
  • null
    • 84 |
  • undefined
    • 85 |
  • never
    • 86 |
87 |

数组

88 |

有 2 种方式定义数组

89 | 
let arr: number[] = [1, 2, 3]; // 元素类型后接上`[]`
 90 | let arr: Array<number> = [1, 2, 3]; // 数组泛型
 91 | let arr: (number | string)[] = [1, '2', '4']; // 元素类型可以是number或string（类似元组）
 92 |
93 |

元组 tuple

94 |

表示一个数组（各个元素的类型不必相同）

95 | 
let list: [string, number]; //第一个元素为string类型，第二个为number类型
 96 | a = ['abc', 123]; //合格
 97 | b = [123, 'abc']; //不合格
 98 |
99 |

枚举

100 |

其实有点类似对象 101 | 看例子吧

102 | 
enum lan {js, ts, css};
103 | console.log(lan.js); // 0   js对应的下标，第一个默认下标为0
104 | 
105 | enum lan {
106 |   js = 3,
107 |   ts,
108 |   css,
109 | }
110 | console.log(lan.js); // 3
111 | console.log(lan.ts); // 4
112 | console.log(lan.css); // 5
113 | 
114 | enum lan {
115 |   js,
116 |   ts = 3,
117 |   css,
118 | }
119 | console.log(lan.js); // 0
120 | console.log(lan.ts); // 3
121 | console.log(lan.css); // 4
122 | console.log(lan[4]); // css
123 | console.log(lan[1]); // undefined
124 | // 第一个默认下标为0，css接着ts的值+1
125 | 
126 | enum lan {js = 'good', ts = 'nice', css = 'well'};
127 | console.log(lan.js); // good
128 | 
129 | // const枚举，为了避免在额外生成的代码上的开销和额外的非直接的对枚举成员的访问。
130 | const enum People {
131 |   name: 'Alan',
132 |   age: 23
133 | }
134 | 
135 | // 编译时会自动转化成常量值，不会保留其他代码
136 | console.log(People.name); // Alan
137 |
138 |

any

139 |

顾名思义，任意值，当我们想为还不清楚类型的变量指定一个类型时， any 就是最好的选择 🤭

140 | 
let a: any = 4;
141 | a = '123'; //合格
142 | 
143 | let arr: any[] = [1, '123', true]; // 和元组很像
144 | arr[1] = 'good';
145 |
146 |

void

147 |

常用于无返回值的函数声明

148 | 
function func(): void {
149 |   console.log('learning typescript...');
150 | }
151 | func(); //合格
152 | 
153 | function func(): void {
154 |   return 1;
155 | }
156 | func(); // 不合格：Type '1' is not assignable to type 'void'
157 |
158 |

null 和 undefined

159 |

用处不大，默认情况下是所有类型的子类型，例如下面代码是没有问题的：

160 | 
let a: string;
161 | a = undefined;
162 | a = null;
163 |
164 |

但是，当指定--strictNullChecks标记时，null 和 undefined 只能赋值给 void 和他们自己本身。

165 |

never

166 |

表示永不存在的值的类型 167 | never 类型是那些总是会抛出异常或根本就不会有返回值的函数表达式或箭头函数表达式的返回值类型； 168 | 变量也可能是 never 类型，当它们被永不为真的类型保护所约束时。

169 |

never 类型是任何类型的子类型，也可以赋值给任何类型；然而，没有类型是 never 的子类型或可以赋值给 never 类型（除了 never 本身之外）。 即使 any 也不可以赋值给 never。

170 | 
function error(message: string): never {
171 |   throw new Error(message);
172 | }
173 | 
174 | // 返回never的函数必须存在无法达到的终点
175 | function infiniteLoop(): never {
176 |   while (true) {}
177 | }
178 |
179 |

结构赋值的写法

180 | 
function sayAge({ name, age }: { name: string | number; age: number }): void {
181 |   console.log(`${name} is ${age} years old`);
182 | }
183 | sayAge({ name: 'Alan', age: 22 });
184 | sayAge({ name: 2, age: 22 });
185 |
186 |

联合类型

187 |

用 | 来表示取值存在多种可能

188 | 
let a: string | number;
189 | a = 1;
190 | a = 'A';
191 |
192 |

类型断言

193 |

可以自己指定一个值的类型 194 | 格式如下 195 | <类型>值 196 | 值 as 类型

197 | 
interface student {
198 |   isStudent: boolean;
199 |   education: number;
200 | }
201 | interface worker {
202 |   isStudent: boolean;
203 |   seniority: number;
204 | }
205 | function Recruit(candidate: worker | student): void {
206 |   if (candidate.isStudent) {
207 |     console.log(`your education is ${(candidate as student).education}`);
208 |   } else {
209 |     console.log(`your seniority is ${(candidate as worker).seniority}`);
210 |   }
211 | }
212 | 
213 | const a: student = { isStudent: true, education: 4 };
214 | const b: worker = { isStudent: false, seniority: 2 };
215 | Recruit(a);
216 | Recruit(b);
217 |
218 |

由于 candidate 使用了联合类型，所以 ts 无法判断 candidate 究竟是属于 student 还是 worker ，所以要使用类型断言来显式告诉 ts。

219 |

当然还有其他方式来实现

220 | 
interface student {
221 |   isStudent: boolean;
222 |   education: number;
223 | }
224 | interface worker {
225 |   isStudent: boolean;
226 |   seniority: number;
227 | }
228 | function Recruit(candidate: worker | student): void {
229 |   'education' in candidate && console.log(`your education is ${candidate.education}`);
230 |   'seniority' in candidate && console.log(`your seniority is ${candidate.seniority}`);
231 | }
232 | 
233 | const a: student = { isStudent: true, education: 4 };
234 | const b: worker = { isStudent: false, seniority: 2 };
235 | Recruit(a);
236 | Recruit(b);
237 |
238 |
    239 |
  • typeof
    • 240 |
  • instanceof
    • 241 |
242 |

非空断言

243 |

!. 对应 --strictNullChecks

244 | 
interface person {
245 |   name: string;
246 | }
247 | function work(personObj?: person) {
248 |   // 由于 personObj 可能不传，所以 personObj 可能为 undefined，使用 !. 可以断言 personObj 不为空
249 |   console.log(personObj!.name);
250 | }
251 |
252 |

接口 interface

253 |

先看一个接口的例子

254 | 
interface person {
255 |   name: string;
256 | }
257 | function work(personObj: person) {
258 |   console.log(personObj.name);
259 | }
260 | let person1 = { name: 'Alan', age: 21 };
261 | work(person1);
262 | let person2 = { age: 21 };
263 | work(person2);
264 |
265 |

image-20200615180720618

266 |

定义接口的关键字是 interface 267 | 这个例子需要传入 work 的参数必须是一个带有 name(string)的对象，可以理解为我要招聘一个有名字的员工，没有名字的都不需要。当然我们的 person1 中还多了一个age属性，这并不会报错。可是当我们直接传递参数时是会出错的。

268 | 
work({ name: 'Alan', age: 21 });
269 |
270 |

那如果我不确定要招聘的员工除了有姓名外还需要其他什么属性时，可以像下面一样重新定义接口就可以解决上面的问题了。

271 | 
interface person {
272 |   name: string;
273 |   [propName: string]: any;
274 | }
275 |
276 |

可选属性

277 |

那如果我的招聘条件是最好懂 typescript 的，这个时候 typescript 就是可有可无的（最好懂，嘿嘿 😜），那我们就要用到可选属性了 278 | 可选属性在可选属性名后面加上一个?

279 | 
interface person {
280 |   name: string;
281 |   ts?: boolean;
282 | }
283 | function Recruit(personObj: person): string {
284 |   if (personObj.ts) {
285 |     return `congratulations!${personObj.name}`;
286 |   } else {
287 |     return `sorry,${personObj.name}, we need a employee who know ts!`;
288 |   }
289 | }
290 | let person1 = { name: 'Alan', age: 21, ts: true };
291 | console.log(Recruit(person1));
292 | let person2 = { name: 'Bob', age: 21 };
293 | console.log(Recruit(person2));
294 |
295 |

只读属性

296 |

我们都知道人的名字都是不可以改变的（一般情况下），这个时候我们对 person 接口里面的 name 属性稍作修改，在属性名 name 前加上readonly。

297 |

:::tip

298 |

当然也可以使用 setter/getter 来实现

299 |

:::

300 | 
interface person {
301 |   readonly name: string;
302 |   ts?: boolean;
303 | }
304 | let person1: person = { name: 'Alan' };
305 | person1.name = 'Bob'; // Cannot assign to 'name' because it is a read-only property.
306 |
307 |

我们发现 readonly 和 const 的作用好像有点相似，那我们什么时候使用 readonly 什么时候使用 const 呢？ 308 | 变量---->const 309 | 属性---->readonly

310 |

函数类型的接口

311 |

接口除了可以描述带有属性的对象外，还可以描述函数类型 312 | 这里创建一个函数来检查你有没有打卡 😁

313 | 
interface attendanceFunc {
314 |   (name: string, startTime: number, endTime: number): boolean;
315 | }
316 | let checkAttendance: attendanceFunc;
317 | checkAttendance = function (name: string, startTime: number, endTime: number): boolean {
318 |   let result = startTime < 9 && endTime > 18;
319 |   return result;
320 | };
321 | console.log(checkAttendance('Alan', 10, 19)); // false
322 |
323 |

看一下接口的声明：

324 | 
interface attendanceFunc {
325 |   (name: string, startTime: number, endTime: number): boolean;
326 | }
327 |
328 |

name,startTime,endTime 放在 () 中代表函数的参数 329 | :boolean 表示函数的返回值类型 330 | 当然上面例子中的checkAttendance的形参以及函数的返回值来说可以不指定类型，因为 checkAttendance 复制给了 attendanceFunc 变量，类型检查器会自动(按照接口中参数的顺序)推断出参数以及返回值的类型，也就是说写成下面这样也是可以的。函数中的参数名可以不和接口中的相同

331 | 
interface attendanceFunc {
332 |   (name: string, startTime: number, endTime: number): boolean;
333 | }
334 | let checkAttendance: attendanceFunc;
335 | checkAttendance = function (n, startTime, endTime) {
336 |   let result = startTime < 9 && endTime > 18;
337 |   return result;
338 | };
339 | console.log(checkAttendance('Alan', 10, 19)); // false
340 |
341 |

接口的继承

342 |

一个接口可以继承 1 个或者多个接口： 343 | 继承使用关键词extends

344 | 
interface person {
345 |   name: string;
346 | }
347 | interface student {
348 |   studentId: number;
349 | }
350 | interface seniorStudent extends person, student {
351 |   grade: string;
352 | }
353 | let student1: seniorStudent = { name: 'Alan', studentId: 1, grade: 'one' };
354 | console.log(student1);
355 |
356 |

类 class

357 |

TS 中的类和 ES6 中的类很相似，这里只介绍不同的地方

358 |

变量修饰符

359 |
    360 |
  • public（默认）
    • 361 |
  • private（私有，不能在声明它的类的外部访问）
    • 362 |
  • protected（和 private 类似，不同的是 protected 声明的变量可以在派生类（即子类）中访问）
    • 363 |
364 |

静态属性 static

365 | 
class Person {
366 |   static fingerNum = 5;
367 | }
368 | 
369 | // 只能通过类来访问
370 | console.log(Person.fingerNum);
371 | // 不能通过实例访问
372 | console.log(new Person().fingerNum);
373 |
374 | 
// 单例模式创建唯一的实例
375 | class singleClass {
376 |   private static instance: singleClass;
377 |   private constructor(public name: string) {}
378 | 
379 |   static getInstance() {
380 |     if (!this.instance) {
381 |       this.instance = new singleClass('Alan');
382 |     }
383 |     return this.instance;
384 |   }
385 | }
386 | 
387 | const class1 = singleClass.getInstance();
388 | const class2 = singleClass.getInstance();
389 | console.log(class1.name); // Alan
390 | console.log(class1 === class2); // true
391 |
392 |

构造函数

393 | 
class Person {
394 |   constructor(name, mobile, sex) {
395 |     this.name = name;
396 |     this.mobile = mobile;
397 |     this.sex = sex;
398 |   }
399 |   public name: string;
400 |   private mobile: string;
401 |   protected sex: string;
402 | }
403 |
404 |

上面的代码可以简写成下面这样

405 | 
class Person {
406 |   constructor(name: string, private mobile: string, protected sex: string) {}
407 | }
408 |
409 |

抽象类

410 |
    411 |
  • 不能被实例化
    • 412 |
  • 要使用的话要声明其派生类，并且重写其中的抽象方法
    • 413 |
414 | 
abstract class Animal {
415 |   constructor(public name: string) {}
416 |   sayHello() {
417 |     console.log('hello');
418 |   }
419 |   // 声明抽象方法
420 |   abstract action(): void;
421 | }
422 | 
423 | class Bird extends Animal {
424 |   constructor(name) {
425 |     super(name);
426 |   }
427 |   action() {
428 |     console.log('jijiji');
429 |   }
430 | }
431 | 
432 | const bird = new Bird('qc');
433 | console.log(bird);
434 | // Bird { name: 'qc' }
435 |
436 |

泛型

437 |
438 |

泛型（Generics）是指在定义函数、接口或类的时候，不预先指定具体的类型，而在使用的时候再指定类型的一种特性。

439 |
440 |

函数用法：<泛型名>

441 | 
function Recruit<T>(name: string, props: T) {
442 |   return name + props;
443 | }
444 | // 显式指定为T为number类型
445 | console.log(Recruit<number>('Alan', 123)); // Alan123
446 | // TS自动推断为number类型，和上面效果一样
447 | console.log(Recruit('Alan', 123)); // Alan123
448 | console.log(Recruit('Alan', [1, 2, 3])); // Alan1,2,3
449 |
450 |

也可以使用多个泛型名，下面的例子结合了接口来完成

451 | 
interface Contact {
452 |   mobile: string;
453 | }
454 | 
455 | interface Address {
456 |   province: string;
457 | }
458 | 
459 | function Recruit<C extends Contact, A extends Address>(name: string, contact: C, address: A) {
460 |   return `${name}'s mobile is ${contact.mobile}, live in ${address.province}`;
461 | }
462 | 
463 | console.log(Recruit('Alan', { mobile: '666' }, { province: 'Shanghai' }));
464 | // Alan's mobile is 666, live in Shanghai
465 |
466 |

类用法

467 | 
interface employee {
468 |   name: string;
469 |   age: number;
470 | }
471 | 
472 | class RecruitManager<T extends employee> {
473 |   constructor(private data: Array<T>) {}
474 |   select(age: number): T {
475 |     return this.data.find((item) => item.age > age);
476 |   }
477 | }
478 | 
479 | const result = new RecruitManager([
480 |   {
481 |     name: 'Alan',
482 |     age: 22
483 |   },
484 |   {
485 |     name: 'Bob',
486 |     age: 18
487 |   }
488 | ]);
489 | console.log(result.select(20));
490 |
491 |

泛型约束

492 |

使用 extends 约束泛型

493 | 
interface info {
494 |   mobile: string;
495 | }
496 | 
497 | // T泛型必须满足info
498 | function Recruit<T extends info>(name: string, props: T) {
499 |   return name + props.mobile;
500 | }
501 | 
502 | console.log(Recruit('Alan', { mobile: '1232910830' })); // Alan1232910830
503 |
504 |

React 相关

505 |

class 组件动态设置 state

506 | 
this.setState({
507 |   [name]: value
508 | } as Pick<CompontentState, keyof CompontentState>);
509 |
-------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------