{"id":27371635,"url":"https://github.com/zemyblue/mongo-query-generator","last_synced_at":"2025-04-13T09:43:57.646Z","repository":{"id":287098728,"uuid":"963516638","full_name":"zemyblue/mongo-query-generator","owner":"zemyblue","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-09T23:48:46.000Z","size":43,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T00:30:20.384Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zemyblue.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-04-09T19:55:42.000Z","updated_at":"2025-04-09T23:48:49.000Z","dependencies_parsed_at":"2025-04-10T00:30:22.226Z","dependency_job_id":"e401c248-dc21-447a-a529-4bc1731afe48","html_url":"https://github.com/zemyblue/mongo-query-generator","commit_stats":null,"previous_names":["zemyblue/mongo-query-generator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemyblue%2Fmongo-query-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemyblue%2Fmongo-query-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemyblue%2Fmongo-query-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemyblue%2Fmongo-query-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zemyblue","download_url":"https://codeload.github.com/zemyblue/mongo-query-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248693976,"owners_count":21146899,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-13T09:43:57.153Z","updated_at":"2025-04-13T09:43:57.637Z","avatar_url":"https://github.com/zemyblue.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mongo Query Generator (with LLaMA3 via Ollama)\n\n이 프로젝트는 자연어로 MongoDB 콘솔 명령어를 생성하는 도구입니다.  \n로컬에서 실행되는 LLaMA3 (Ollama 기반)를 통해 비용 없이 사용 가능합니다.\n\n---\n\n## 🤩 기능\n- 자연어 → MongoDB 명령어 자동 변환\n- Ollama + LLaMA3 기반 로컬 LLM 사용 (OpenAI 비용 無)\n- Frontend: Vite + React + TypeScript\n- Backend: Express + TypeScript\n\n---\n\n## 🛠️ 처기 설정 및 실행 방법\n\n### 1. GitHub 클론\n```bash\ngit clone https://github.com/zemyblue/mongo-query-generator.git\ncd mongo-query-generator\n```\n\n### 2. Ollama 설치 (Mac/Linux)\n```bash\n# Mac\nbrew install ollama\n\n# Linux\ncurl -fsSL https://ollama.com/install.sh | sh\n```\n\n### 3. LLaMA3 모델 설치 및 실행 확인\n```bash\n# background에서 수동 실행하고 싶다면\nnohup ollama serve \u003e logs/ollama.log 2\u003e\u00261 \u0026\n# 또는 자동 실행\nbrew services start ollama\n\n# 모델 다운로드 (ollama가 실행되어 있어야 한다)\nollama pull llama3\n\n# 실행 상태 확인 (정상일 경우 JSON 응답)\ncurl http://localhost:11434\n```\n\n\u003e 프로젝트에서는 `./run.sh` 실행 시 Ollama가 켜져 있지 않으면 자동으로 Background에서 실행됩니다.\n\n---\n\n### 4. MongoDB 접속 설정 (.env)\nMongoDB에서 컬렉션 정보를 자동으로 불러오려면 `.env` 파일에 아래 정보를 설정해야 합니다:\n\n`.env.example` 예시:\n```env\nPORT=3001\nMONGODB_URI=mongodb://localhost:27017\nMONGODB_DB=your_database_name\n# 인증이 필요한 경우:\n# MONGODB_URI=mongodb://username:password@localhost:27017\n```\n\n\u003e 복사하여 `.env` 파일로 만들어 사용하세요:\n```bash\ncp server/.env.example server/.env\n```\n\n---\n\n### 5. Backend 실행\n```bash\ncd server\ncp .env.example .env  # 또는 직접 PORT 설정\nnpm install\nnpm run dev\n```\n\n\u003e 서버는 `http://localhost:3001`에서 실행됩니다.\n\n---\n\n### 6. Frontend 실행\n```bash\ncd ../client\nnpm install\nnpm run dev\n```\n\n\u003e 브라우저에서 `http://localhost:5173` 접속\n\n---\n\n## 📦 MongoDB 컬렉션 정보 자동 업데이트\n\n프론트엔드의 `🔄 컬렉션 동기화` 버튼을 클릭하면 MongoDB에 접속하여 다음 동작을 수행합니다:\n- 모든 컬렉션 목록 불러오기\n- 각 컬렉션에서 샘플 문서 하나 추출\n- 키와 값을 분석하여 필드명 및 타입 추론\n- `collections.json` 파일 자동 갱신\n\n\u003e `.env`에 MongoDB 접속 정보가 정확히 설정되어 있어야 작동합니다.\n\n---\n\n## 🚀 실행 방법 요약\n\n### ✅ 1. Local 개발 모드 실행 (스크립트 하나로 실행)\n\n```bash\nchmod +x run.sh\n./run.sh\n```\n\n\u003e 클라이언트 빌드 후 서버가 자동 실행됩니다. 브라우저에서 [http://localhost:5173](http://localhost:5173) 로 접속하세요.\n\n---\n\n### ✅ 2. Docker로 실행하기\n\n```bash\ndocker-compose build\ndocker-compose up\n```\n\n- 서버 URL: http://localhost:3001\n- 클라이언트 URL: http://localhost:5173\n\n\u003e collections.json은 volume으로 링크되어 있어 데이터가 유지됩니다.\n\n---\n\n## 🛠 TypeScript 오류 해결 가이드\n\n`uuid` 관련 오류 발생 시 아래 명령어로 타입 패키지를 설치하세요:\n\n```bash\ncd server\nnpm install --save-dev @types/uuid\n```\n\n\u003e TypeScript는 외부 라이브러리의 타입 정보를 필요로 하며, 위 명령어는 `uuid`의 타입 정의를 추가합니다.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzemyblue%2Fmongo-query-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzemyblue%2Fmongo-query-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzemyblue%2Fmongo-query-generator/lists"}