# Local Service Setup Guide ### Pre-requisites * All resources under Introduction to Manage Learn Category * NodeJS - v12 * MongoDB - v4.4.0 * Basics of Cloud Storage * Basics of Kafka ### Clone the service repository onto your system Create a new folder where you want to clone the repository. * Navigate to that directory using the terminal. * Execute the git commands to clone the repository using the provided link from the code tab. #### Git link {% embed url="" %} ``` https://github.com/shikshalokam/ml-core-service.git ``` command to clone ``` git clone https://github.com/shikshalokam/ml-core-service.git ``` ### Create .env file Create a file named `.env` and copy the environment-specific data corresponding to that service into the `.env` file. ``` # Environment configurations file APPLICATION_PORT = "3000" // Application port number APPLICATION_ENV = "development" // Application running enviornment # Mongo DB Configuration MONGODB_URL = "mongodb://localhost:27017/sl-prod" // Mongo DB URL INTERNAL_ACCESS_TOKEN = "Fg*************yr" // Internal access token for accessing Internal services APIs #Cloud Storage Configuration CLOUD_STORAGE = "AWS/GC/AZURE" // Cloud storage provider. # Google Cloud Configuration GCP_PATH = "./generics/helpers/credentials/storage.json" // Path to the the Google cloud authentication key GCP_BUCKET_NAME = "gcp bucket name" // Google cloud bucket name # Azure Cloud Configuration AZURE_ACCOUNT_NAME = "AZURE_KEY" // Azure account name AZURE_ACCOUNT_KEY = "Ih..............NBN" // Azure account key AZURE_STORAGE_CONTAINER = "Azure_bucket" // Azure container/bucket name # AWS Cloud Configuration AWS_ACCESS_KEY_ID = "AK...........WA" // Aws cloud storage access key id AWS_SECRET_ACCESS_KEY = "QB......................9sB" // Aws cloud storage access key AWS_BUCKET_NAME = "aws bucket name" // Aws cloud storage bucket name AWS_BUCKET_REGION = "ap-south-1" // Aws cloud storgae region AWS_BUCKET_ENDPOINT = "s3.ap-south-1.amazonaws.com" // Aws cloud storage api's endpoint # OFFLINE TOKEN VALIDATION KEYCLOAK_PUBLIC_KEY_PATH = "keycloak-public-keys" // Path to Offline token public key # ML Survey Service ML_SURVEY_SERVICE_URL = "http://ml-survey-service:3000" // ML Survey service url # ML Project Service Service ML_PROJECT_SERVICE_URL = "http://ml-project-service:3000" // ML Project service url #USER service USER_SERVICE_URL = "http://user-service:3000" // Base url of the sunbird enviornment CSV_REPORTS_PATH = "public/report" // Report path APP_PORTAL_BASE_URL = "https://dev.sunbirded.org" FORM_SERVICE_URL = "http://player:3000" // Base url for form search # Oracle Cloud Configuration OCI_ACCESS_KEY_ID = '23b90..............d01d' // Oracle cloud storage access key Id OCI_SECRET_ACCESS_KEY = '22levMw5Ci............SmNE=' // Oracle cloud storage secret access key OCI_BUCKET_NAME = 'oracle cloud bucket name' // Oracle cloud bucket name OCI_BUCKET_REGION = 'ap-hyderabad-1' // Oracle cloud bucket region OCI_BUCKET_ENDPOINT = 'https://pmt5.compat.storage.ap-h1.oraclecloud.com' // Oracle cloud bucket endPoint # KAFKA Configurations KAFKA_COMMUNICATIONS_ON_OFF = "ON/OFF" // Kafka enable or disable communication flag KAFKA_URL = "100.0.0.1:9092" // IP address of kafka server with port without HTTP KAFKA_GROUP_ID = "mlcore" // Kafka group id PROGRAM_USERS_JOINED_TOPIC = "dev.programuser.info" // Kafka submission topic for pushing program joined user's data TIMEZONE_DIFFRENECE_BETWEEN_LOCAL_TIME_AND_UTC = +05:30 //Time zone diffrenece between local and UTC ``` ### Install Dependencies To install dependencies from a `package.json` file in Visual Studio Code, you can use the integrated terminal. Here are the steps: * Open the integrated terminal by going to View > Terminal or using the shortcut Ctrl+\` (backtick). * In the terminal, navigate to the directory where the package.json file is located. * Run the command `npm install` or `yarn install`, depending on your preferred package manager. * The package manager will read the package.json file and install all the dependencies specified in it. * Wait for the installation process to complete. You should see progress indicators or a success message for each installed dependency. * Once the installation is finished, the dependencies listed in the package.json file will be installed in a node\_modules directory in your project. ### Setting the keycloak * Create a folder on service directory named: `keycloak-public-keys` * Inside that folder create a file `GRxxx....................xxxxx60fA` **for keycloak file please contact Backend Team** ### Setup Database Before proceeding with these steps, ensure that you have MongoDB installed on your computer. For a graphical user interface (GUI) for MongoDB, you can choose to install Robo 3T. * Obtain the latest database dump from the backend team. * Restore the database in your local environment using the following command: For Windows/Linux: `mongorestore ` For macOS: `mongorestore -d ` Note: Add `` to mongoDB url in `.env` file. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://ed.sunbird.org/release-6.0.0/use/source-code/manage-learn/ml-core-service/local-service-setup-guide.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.