servostar
/
brunsviga-demo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
21 Commits 5 Branches 0 Tags 378 KiB
TypeScript 65.5%
JavaScript 18.1%
HTML 7.4%
Dockerfile 5%
CSS 4%
Go to file
Sven Vogel 7c38e77329
Gitea Vite Build Action / Vite-Build (push) Successful in 41s Details
feat(readme): added preview image 		2024-10-25 00:56:59 +02:00
.gitea/workflows fix(ci): fixed vite build action title 2024-10-24 20:02:43 +02:00
assets feat(readme): added preview image 2024-10-25 00:56:59 +02:00
public feat(three): added ambient light, directional light, base plate 2024-10-25 00:12:57 +02:00
src fix(three): removed unused import 2024-10-25 00:15:43 +02:00
.gitignore build(vite): initialized vite project with react template 2024-10-24 19:15:59 +02:00
Dockerfile feat(docker): added multi stage dockerfile 2024-10-25 00:34:53 +02:00
README.md feat(readme): added preview image 2024-10-25 00:56:59 +02:00
eslint.config.js build(vite): initialized vite project with react template 2024-10-24 19:15:59 +02:00
index.html build(vite): initialized vite project with react template 2024-10-24 19:15:59 +02:00
package-lock.json feat(three): added reat-three dependency 2024-10-24 23:58:21 +02:00
package.json feat(three): added reat-three dependency 2024-10-24 23:58:21 +02:00
tailwind.config.js feat(tailwindcss): added tailwindcss 2024-10-24 21:24:06 +02:00
tsconfig.app.json build(vite): initialized vite project with react template 2024-10-24 19:15:59 +02:00
tsconfig.app.tsbuildinfo feat(three): added sample scene 2024-10-24 23:58:58 +02:00
tsconfig.json build(vite): initialized vite project with react template 2024-10-24 19:15:59 +02:00
tsconfig.node.json build(vite): initialized vite project with react template 2024-10-24 19:15:59 +02:00
tsconfig.node.tsbuildinfo fix(tailwindcss): removed unused imports and App.css 2024-10-24 21:28:01 +02:00
vite.config.ts feat(three): added sample scene 2024-10-24 23:58:58 +02:00

README.md

banner

Technology demonstration for 3D simulation of Brunsviga RK 13

This repository is a demonstration of web technologies that might be used for simulating the Brunsviga RK 13 mechanical calculator. The demo is designed to be small and lightweight in deploment.

We use vite as the build system for a react.js web application that makes use three.js WebGL capabilites in order to render 3D objects and animate them in realtime. Typescript is the preferred language as it offers relative type-safety during development. The user interface is styled with tailwindcss and will refer to the paper, source code and some refernce documentation for the Brunsviga RK 13.

The built application can be delpoyed via a static web server such as Nginx (see docker container).

<img src="./assets/preview.png" alt="preview" width="80%>

☁️ Technology Stack

  • Vite
  • React
  • Tailwind CSS
  • Three.js

🚀 Getting Started

In order to get started, clone the repository:

git clone https://git.montehaselino.de/servostar/brunsviga-demo.git

Then build compile the application and run in development mode:

npm ci && npm run dev

🐋 Docker Container

The application can be build and launched in a multi stage container:

docker build --tag brunsviga-demo:latest .

Then run the container on port 80:

docker run -p 80:80 brunsviga-demo:latest