Skip to content

AxLab-UofC/SHAPE-IT

Repository files navigation

SHAPE-IT WebVersion

This service is a Flask-based application that uses the LangChain library to generate scripts for controlling shape display hardware. It leverages OpenAI's language models to process and respond to user inputs.

Project Overview

This project is a web-based application designed to dynamically generate and control interactive animations. It leverages both front-end and back-end technologies to create a responsive and interactive 3D environment.

Key Features

  • 3D Graphics Rendering: Utilizes Three.js for rendering interactive 3D graphics in a web browser.
  • Dynamic Script Generation: Python backend dynamically generates JavaScript scripts based on user interactions.
  • Real-time Parameter Control: Interactive sliders allow users to adjust parameters like amplitude, frequency, and wave speed in real time.
  • Responsive Design: Adapts to various screen sizes and user inputs for a seamless experience.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js
  • Python 3.x
  • A modern web browser

Installation

Before you begin, ensure you have Python installed on your system. This application has been tested with Python 3.9

Step 1: Clone the Repository

Clone this repository to your local machine

git clone git@github.com:AxLab-UofC/SHAPE-IT.git
cd SHAPE-IT/WebShapeDisplay

Step 2: Set Up a Virtual Environment

It's recommended to use a virtual environment to manage dependencies:

conda create --name shapeit python=3.9
conda activate shapeit

Step 3: Install Dependencies

Install the required Python packages:

pip install -r requirements.txt

Step 4: Environment Variables

The application uses environment variables for configuration. Create a .env file in the root directory and add the necessary variables:

# Example .env file
OPENAI_API_KEY=your_openai_api_key
# Add other necessary environment variables here

Step 5: Running the Application

Run the Flask backend:

python run.py

The service will start on localhost at port 5001.

Install Live Server from the Visual Studio Extension Then click Go Live on the bottom right corner then click the WebShapeDisplay folder

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •