🚀Getting Started

Prerequisites

  • Rust installed

  • Soroban SDK installed

  • Stellar Testnet account

  • Docker (optional, for local testnet)

🚀 Frontend Installation

📥 Clone the repository:

git clone https://github.com/RudrakshSJoshi/StellarOrbit.git

📂 Install dependencies:

cd frontend  
cd Stellar-IDE  
npm install  

🖥️ Start the IDE:

npm run dev  

🚀 Backend Installation

📥 Clone the repository:

🦀 1. Install Rust

macOS/Linux:


🌟 2. Install Stellar CLI

macOS:


📦 3. Install Node.js Dependencies


🖥️ 4. Run the Server

🚀 Agent Backend Installation

📥 Clone the repository:


Prerequisites

  • Python 3.7 or higher

  • pip package manager


⚙️ Setup Instructions

🏗️ 1. Create a Virtual Environment

To isolate the project dependencies, create a virtual environment using venv:


🔑 2. Activate the Virtual Environment

Activate the virtual environment to ensure all dependencies are installed within it.

On Windows:

On macOS/Linux:


📦 3. Install Dependencies

Navigate to the agent_backend directory and install the required dependencies:


🚀 4. Start the Agent Backend Server

Once the dependencies are installed, start the agent backend server using Uvicorn:

  • main:app – Refers to the app object in the main.py file

  • --reload – Enables auto-reloading of the server when code changes are detected

  • --port 8000 – Specifies the port on which the server will run

  • --host 0.0.0.0 – Allows the server to be accessible from any IP address


🌐 5. Access the Agent Backend

Once the server is running, you can access the agent backend by navigating to:

👉 http://localhost:8000arrow-up-right

If running on a remote server, replace localhost with the server's IP address.


📝 Additional Notes

  • Ensure the virtual environment is activated whenever working on the project.

  • Use deactivate to exit the virtual environment when done.

  • For production, consider removing the --reload flag and using a process manager like gunicorn with Uvicorn workers.

Last updated