मुख्य कंटेंट तक स्किप करें

स्थानीय विकास पर्यावरण सेटअप गाइड

इस दस्तावेज़ में बताया गया है कि कैसे स्थानीय रूप से सभी आवश्यक सेवा घटकों सहित एक पूर्ण MCP Gateway विकास पर्यावरण को स्थापित और प्रारंभ किया जाए।

पूर्वापेक्षाएँ​

शुरू करने से पहले, सुनिश्चित करें कि आपके सिस्टम में निम्नलिखित सॉफ्टवेयर स्थापित हैं:

  • Git
  • Go 1.24.1 या उच्चतर संस्करण
  • Node.js v20.18.0 या उच्चतर संस्करण
  • npm

परियोजना आर्किटेक्चर अवलोकन​

MCP Gateway परियोजना निम्नलिखित मुख्य घटकों से बनी है:

  1. apiserver - कॉन्फ़िगरेशन प्रबंधन, उपयोगकर्ता इंटरफ़ेस और अन्य API सेवाएँ प्रदान करता है
  2. mcp-gateway - मुख्य गेटवे सेवा, MCP प्रोटोकॉल रूपांतरण को संभालती है
  3. mock-server - विकास परीक्षण के लिए उपयोगकर्ता सेवा का अनुकरण करता है
  4. web - प्रबंधन इंटरफेस फ्रंटएंड

विकास पर्यावरण प्रारंभ करना​

1. परियोजना को क्लोन करें​

MCP Gateway कोड रिपॉजिटरी पर जाएँ, Fork बटन पर क्लिक करें, परियोजना को अपने GitHub खाते में फोर्क करें।

2. स्थानीय रूप से क्लोन करें​

अपने फोर्क किए गए रिपॉजिटरी को स्थानीय रूप से क्लोन करें:

git clone https://github.com/आपका-github-उपयोगकर्ता-नाम/mcp-gateway.git

3. पर्यावरण निर्भरताओं को आरंभ करें​

परियोजना निर्देशिका में प्रवेश करें:

cd unla

निर्भरताएँ स्थापित करें:

go mod tidy
cd web
npm i

4. विकास पर्यावरण प्रारंभ करें​

cp .env.example .env
cd web
cp .env.example .env

नोट: आप बिना किसी बदलाव के डिफ़ॉल्ट कॉन्फ़िगरेशन के साथ विकास शुरू कर सकते हैं, लेकिन आप अपने पर्यावरण या विकास आवश्यकताओं को पूरा करने के लिए कॉन्फ़िगरेशन फ़ाइलों को संशोधित भी कर सकते हैं, जैसे Disk, DB आदि को बदलना।

नोट: आपको सभी सेवाओं को चलाने के लिए 4 टर्मिनल विंडो की आवश्यकता हो सकती है। होस्ट मशीन पर कई सेवाओं को चलाने का यह दृष्टिकोण विकास के दौरान पुनः प्रारंभ और डिबगिंग को आसान बनाता है।

4.1 mcp-gateway प्रारंभ करें​

go run cmd/gateway/main.go

mcp-gateway डिफ़ॉल्ट रूप से http://localhost:5235 पर प्रारंभ होगा, MCP प्रोटोकॉल अनुरोधों को संभालेगा।

4.2 apiserver प्रारंभ करें​

go run cmd/apiserver/main.go

apiserver डिफ़ॉल्ट रूप से http://localhost:5234 पर प्रारंभ होगा।

4.3 mock-server प्रारंभ करें​

go run cmd/mock-server/main.go

mock-server डिफ़ॉल्ट रूप से http://localhost:5235 पर प्रारंभ होगा।

4.4 वेब फ्रंटएंड प्रारंभ करें​

npm run dev

वेब फ्रंटएंड डिफ़ॉल्ट रूप से http://localhost:5236 पर प्रारंभ होगा।

अब आप http://localhost:5236 पर अपने ब्राउज़र में प्रबंधन इंटरफ़ेस तक पहुंच सकते हैं। डिफ़ॉल्ट उपयोगकर्ता नाम और पासवर्ड आपके पर्यावरण चर (रूट निर्देशिका की .env फ़ाइल में) द्वारा निर्धारित किए जाते हैं, विशेष रूप से SUPER_ADMIN_USERNAME और SUPER_ADMIN_PASSWORD। लॉगिन करने के बाद, आप प्रबंधन इंटरफ़ेस में उपयोगकर्ता नाम और पासवर्ड बदल सकते हैं।

सामान्य समस्याएँ​

पर्यावरण चर सेटिंग्स​

कुछ सेवाओं को ठीक से काम करने के लिए विशिष्ट पर्यावरण चर की आवश्यकता हो सकती है। आप एक .env फ़ाइल बना सकते हैं या कमांड शुरू करने से पहले इन चरों को सेट कर सकते हैं:

# उदाहरण
export OPENAI_API_KEY="आपकी_api_key"
export OPENAI_MODEL="gpt-4o-mini"
export APISERVER_JWT_SECRET_KEY="आपकी_गुप्त_कुंजी"

कोड योगदान वर्कफ़्लो​

नई सुविधाओं को विकसित करने या बग्स को ठीक करने से पहले, अपने विकास वातावरण को सेट करने के लिए इन चरणों का पालन करें:

  1. अपने फोर्क रिपॉजिटरी को स्थानीय रूप से क्लोन करें:
git clone https://github.com/your-github-username/unla.git
  1. अपस्ट्रीम रिपॉजिटरी जोड़ें:
git remote add upstream git@github.com:amoylab/unla.git
  1. अपस्ट्रीम कोड के साथ सिंक्रनाइज़ करें:
git pull upstream main
  1. अपने फोर्क रिपॉजिटरी में अपडेट पुश करें (वैकल्पिक):
git push origin main
  1. नई फीचर ब्रांच बनाएं:
git switch -c feat/your-feature-name
  1. विकास के बाद, अपनी ब्रांच को फोर्क रिपॉजिटरी में पुश करें:
git push origin feat/your-feature-name
  1. GitHub पर एक Pull Request बनाएं ताकि आपकी ब्रांच मुख्य रिपॉजिटरी की main ब्रांच में मर्ज हो सके।

सुझाव:

  • ब्रांच नामकरण सम्मेलन: नई सुविधाओं के लिए feat/ प्रीफिक्स, बग फिक्स के लिए fix/ प्रीफिक्स का उपयोग करें
  • PR जमा करने से पहले सुनिश्चित करें कि आपका कोड सभी परीक्षणों को पास करता है
  • कोड कॉन्फ्लिक्ट्स से बचने के लिए अपने फोर्क रिपॉजिटरी को अपस्ट्रीम रिपॉजिटरी के साथ सिंक्रनाइज़ रखें

अगले कदम​

स्थानीय विकास पर्यावरण को सफलतापूर्वक प्रारंभ करने के बाद, आप: