developer_workstation.md

CosmosAIGraph : Developer Workstation Setup

Required Software

These are required to simply execute the solution on your workstation:

• Windows 11 with PowerShell
  • For Development, Windows 11 with PowerShell is recommended
  • Working bash scripts are also provided for macOS users
• Git
  • Distributed source control system. Integrates with GitHub
  • Enables you to git clone this GitHub repository
• Python3
  • This solution uses Python command-line and web application programs, not Jupyter Notebooks
  • Python version 3.12.x is recommended
  • Conda is not recommended for this solution
• OpenJDK Java 21
  • The new graph microservice is implemented in Java 21, Spring Boot, and Apache Jena
  • Download from: https://learn.microsoft.com/en-us/java/openjdk/download#openjdk-21
  • See Understanding the Code
• A Java IDE, such as:
  • Eclipse
  • Jetbrains Intellij
  • Visual Studio Code (VSC)
• Gradle Build Tool, version 8.12
  • Used to compile and package the Java code
  • See https://gradle.org/
  • See the build.gradle file in the repo
  • Alternately use the Maven build tool
    • Create your pom.xml file per the build.gradle contents.
• A Mongo Shell Program, such as:
  • Azure Data Studio
    • This is the recommended mongosh program for the CosmosAIGraph solution
    • See the configuration instructions here:
      • https://learn.microsoft.com/en-us/azure-data-studio/quickstart-azure-cosmos-db-mongodb?tabs=mongodb-vcore
  • mongosh
    • The MSI installer option is recommended if you choose to use this program
  • Studio3T

Also, a working knowledge of pip and Python Virtual Environments is necessary. See https://realpython.com/python-virtual-environments-a-primer/.

This reference implementation contains several venv.ps1 and venv.sh scripts which create the Python Virtual Environments for this solution. Once these are created, they can be activated with the following command:

> .\venv\Scripts\Activate.ps1

Recommended Software

To develop your own solutions based on this reference application, this additional software is recommended:

• Docker Desktop
  • Docker Desktop will enable you to both build and execute containers
• GitHub Desktop
  • Provides a nice UI and may be easier to use than the git command-line program
• Visual Studio Code (VSC)
  • Lightweight IDE with multi-language support, including Python
  • Integrates well with Azure, see https://code.visualstudio.com/docs/azure/extensions
• GitHub Copilot
  • AI-powered coding assistant
  • Copilot integrates nicely with VSC; see https://code.visualstudio.com/docs/copilot/overview