https://github.com/compas-dev/compas-webviewer
COMPAS WebViewer using Vue, ThreeJS, FastAPI
https://github.com/compas-dev/compas-webviewer
compas fastapi threejs vue
Last synced: 12 days ago
JSON representation
COMPAS WebViewer using Vue, ThreeJS, FastAPI
- Host: GitHub
- URL: https://github.com/compas-dev/compas-webviewer
- Owner: compas-dev
- Created: 2024-01-31T17:38:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-29T09:47:25.000Z (5 months ago)
- Last Synced: 2025-03-24T22:51:24.414Z (29 days ago)
- Topics: compas, fastapi, threejs, vue
- Language: Vue
- Homepage: http://compas.dev/compas-webviewer/
- Size: 1020 KB
- Stars: 5
- Watchers: 6
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# COMPAS WebViewer
This repo provides a basic Vue + ThreeJS + FastAPI setup for experimenting with COMPAS in the browser.
The repo is configured for local development, with COMPAS running on a local server...
## Installation
Set up the Vue project.
```bash
yarn install
```
Install COMPAS and other required Python packages.
```bash
pip install -r requirements.txt
```
## Starting the Client
To start the frontend development server with hot-reload, run the following command. The server will be accessible at [http://localhost:3000](http://localhost:3000):
```bash
yarn dev
```
## Starting the Server
To start the COMPAS backend server:
```bash
python server.py
```
## Usage
The viewer is available at [http://localhost:3000](http://localhost:3000).
It has a few buttons that run some basic functions on the server and visualise the result in the ThreeJS CAD environment.
The "Getting Started" button runs the code from the corresponding example on the COMPAS main website: [Getting Started](https://tomvanmele.github.io/compas2.dev/#/gettingstarted).