Skip to main content

​
Prerequisites

  • Python 3.11 or higher
  • pip package manager
  • Git (for development)

​
Install Roboticks SDK

pip install roboticks-sdk

​
Verify Installation

from roboticks_sdk import RoboticksClient
print("Roboticks SDK installed successfully!")

​
Development Setup

For contributing to Roboticks or running the platform locally:

​
Backend Setup

cd backend
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

​
Frontend Setup

cd frontend
npm install
npm run dev

​
Infrastructure Setup

cd infrastructure
npm install
npm install -g aws-cdk

​
Docker Development

Run the full platform locally with Docker: 
docker compose up -d
This starts:
  • Backend API (port 8000)
  • Frontend (port 3000)
  • PostgreSQL database
  • Redis cache
  • InfluxDB metrics

​
Next Steps