Commit d5fdba8

committed

Update the README file, modify the knowledge base initialization command and dependency installation, adjust the database path Settings, correct the knowledge file path in the configuration file, and remove unnecessary type declarations.

1 parent a01a648 commit d5fdba8Copy full SHA for d5fdba8

File tree

6 files changed

+19

-21

lines changed

README.md
README_ZH.md
backend
- app_factory.py
- config
  - init_config.yaml.copy
- requirements.txt
webui/typings
- components.d.ts

6 files changed

+19

-21

lines changed

`‎README.md‎`

Lines changed: 3 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -270,7 +270,7 @@ flask db upgrade # Synchronize to database`
`270`	`270`	`# Initialize knowledge base (Optional, can be done manually in the frontend after starting the frontend project)`
`271`	`271`	`# 1. First rename config/init_config.yaml.copy to config/init_config.yaml`
`272`	`272`	`# 2. Modify the relevant information in config/init_config.yaml. If you want to initialize the knowledge base, Embedding Model is required`
`273`		`-python3 init_knowledge_base.py --init_all`
	`273`	`+python init_knowledge_base.py --config_file xxxxxxxxx`
`274`	`274`
`275`	`275`	`# Start backend service (The backend service port can also be modified in app.py, currently 30006)`
`276`	`276`	`python app.py`
`@@ -279,11 +279,10 @@ python app.py`
`279`	`279`	`cd CrackSQL/webui`
`280`	`280`
`281`	`281`	`# Install dependencies`
`282`		`-yarn cache clean`
`283`		`-yarn install`
	`282`	`+pnpm install`
`284`	`283`
`285`	`284`	`# Start development server`
`286`		`-yarn dev`
	`285`	`+pnpm run dev`
`287`	`286`
`288`	`287`	`# Visit http://localhost:50212 to use the Web interface`
`289`	`288`

`‎README_ZH.md‎`

Lines changed: 3 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ flask db upgrade # 同步到数据库`
`171`	`171`	`# 初始化知识库(可选,也可以在启动前端项目后在前端手动完成)`
`172`	`172`	`# 1. 首先将config/init_config.yaml.copy重命名为config/init_config.yaml`
`173`	`173`	`# 2. 修改config/init_config.yaml中的相关信息。如果要初始化知识库,需要Embedding Model`
`174`		`-python3 init_knowledge_base.py --init_all`
	`174`	`+python init_knowledge_base.py --config_file xxxxxxxxx`
`175`	`175`
`176`	`176`	`# 启动后端服务(后端服务端口也可以在app.py中修改,目前为30006)`
`177`	`177`	`python app.py`
`@@ -180,11 +180,10 @@ python app.py`
`180`	`180`	`cd CrackSQL/webui`
`181`	`181`
`182`	`182`	`# 安装依赖`
`183`		`-yarn cache clean`
`184`		`-yarn install`
	`183`	`+pnpm install`
`185`	`184`
`186`	`185`	`# 启动开发服务器`
`187`		`-yarn dev`
	`186`	`+pnpm run dev`
`188`	`187`
`189`	`188`	`# 访问http://localhost:50212使用Web界面`
`190`	`189`

`‎backend/app_factory.py‎`

Lines changed: 9 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -130,19 +130,20 @@ def create_app(config_name='PRODUCTION', config_path=None):`
`130`	`130`
`131`	`131`	`# Dynamically set database path`
`132`	`132`	`# Use user execution directory`
`133`		`- current_dir = os.getcwd()`
`134`		`- instance_dir = os.path.join(current_dir, 'instance')`
`135`		`- logs_dir = os.path.join(current_dir, 'logs')`
	`133`	`+ current_dir = Path.cwd()`
	`134`	`+ instance_dir = current_dir/'instance'`
	`135`	`+ logs_dir = current_dir/'logs'`
`136`	`136`	`# Ensure directory exists`
`137`		`- os.makedirs(instance_dir, exist_ok=True)`
`138`		`- os.makedirs(logs_dir, exist_ok=True)`
	`137`	`+ instance_dir.mkdir(exist_ok=True)`
	`138`	`+ logs_dir.mkdir(exist_ok=True)`
`139`	`139`
`140`	`140`	`# Set database file path`
`141`		`- db_path = os.path.join(instance_dir, 'info.db')`
	`141`	`+ db_path = instance_dir/'info.db'`
`142`	`142`	`print(f"Using database: {db_path}")`
`143`	`143`
`144`		`- # Update database URI`
`145`		`- app.config['SQLALCHEMY_DATABASE_URI'] = f'sqlite:////{db_path}'`
	`144`	`+ # Update database URI - using as_uri() to get the correct format for SQLAlchemy`
	`145`	`+ db_uri = db_path.as_uri().replace('file:', '')`
	`146`	`+ app.config['SQLALCHEMY_DATABASE_URI'] = f'sqlite://{db_uri}'`
`146`	`147`
`147`	`148`	`# Load logging configuration`
`148`	`149`	`logging_config_path = app.config.get('LOGGING_CONFIG_PATH')`

`‎backend/config/init_config.yaml.copy‎`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -34,20 +34,20 @@ KNOWLEDGE_BASES:`
`34`	`34`	`kb_info: "MySQL数据库知识库,包含MySQL的关键字、函数、操作符等信息" # Knowledge base description`
`35`	`35`	`embedding_model: "text-embedding-ada-002" # Embedding model to use`
`36`	`36`	`knowledge_files: # Knowledge files to import`
`37`		`- - "./data/processed_document/mysql_8_kb.json" # Knowledge file path`
	`37`	`+ - "../data/processed_document/mysql_8_kb.json" # Knowledge file path`
`38`	`38`
`39`	`39`	`# PostgreSQL knowledge base`
`40`	`40`	`- kb_name: "postgresql_knowledge" # Knowledge base name`
`41`	`41`	`db_type: "postgresql" # Database type`
`42`	`42`	`kb_info: "PostgreSQL数据库知识库,包含PostgreSQL的关键字、函数、操作符等信息" # Knowledge base description`
`43`	`43`	`embedding_model: "text-embedding-ada-002" # Embedding model to use`
`44`	`44`	`knowledge_files: # Knowledge files to import`
`45`		`- - "./data/processed_document/pg_14_kb.json"`
	`45`	`+ - "../data/processed_document/pg_14_kb.json"`
`46`	`46`
`47`	`47`	`# Oracle knowledge base`
`48`	`48`	`- kb_name: "oracle_knowledge" # Knowledge base name`
`49`	`49`	`db_type: "oracle" # Database type`
`50`	`50`	`kb_info: "Oracle 数据库知识库,包含Oracle的关键字、函数、操作符等信息" # Knowledge base description`
`51`	`51`	`embedding_model: "text-embedding-ada-002" # Embedding model to use`
`52`	`52`	`knowledge_files: # Knowledge files to import`
`53`		`- - "./data/processed_document/oracle_11_kb.json"`
	`53`	`+ - "../data/processed_document/oracle_11_kb.json"`

`‎backend/requirements.txt‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ openai>=1.3.0`
`26`	`26`	`aiohttp>=3.8.0 # For asynchronous HTTP requests`
`27`	`27`	`tenacity>=8.2.0 # For retry mechanism`
`28`	`28`	`sentence-transformers>=2.2.0 # For text vectorization`
`29`		`-numpy>=1.24.0 # Scientific computing`
	`29`	`+numpy==1.24.0 # Scientific computing`
`30`	`30`	`scikit-learn>=1.0.0 # For vector calculation`
`31`	`31`	`chromadb>=0.4.15 # Chroma vector database`
`32`	`32`

`‎webui/typings/components.d.ts‎`

Lines changed: 0 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,6 @@ declare module '@vue/runtime-core' {`
`13`	`13`	`CreateKnowledgeBase: typeof import('./../src/components/CreateKnowledgeBase.vue')['default']`
`14`	`14`	`DatabaseConfigForm: typeof import('./../src/components/DatabaseConfigForm.vue')['default']`
`15`	`15`	`ElSvgIcon: typeof import('./../src/components/ElSvgIcon.vue')['default']`
`16`		`- ProcessItem: typeof import('./../src/components/ProcessItem.vue')['default']`
`17`	`16`	`RouterLink: typeof import('vue-router')['RouterLink']`
`18`	`17`	`RouterView: typeof import('vue-router')['RouterView']`
`19`	`18`	`SqlInput: typeof import('./../src/components/SqlInput.vue')['default']`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit d5fdba8

File tree

6 files changed

6 files changed

`‎README.md‎`

`‎README_ZH.md‎`

`‎backend/app_factory.py‎`

`‎backend/config/init_config.yaml.copy‎`

`‎backend/requirements.txt‎`

`‎webui/typings/components.d.ts‎`

0 commit comments