Compare commits

...

11 Commits

Author SHA1 Message Date
Sven Vogel 8862475e72 fix(dockerfile): changed ownership to user with id 1000 and gid 1000
Gitea Vite Build Action / Vite-Build (push) Successful in 46s Details
2024-10-28 14:03:43 +01:00
Sven Vogel 5c8ade73fb feat: added MIT license
Gitea Vite Build Action / Vite-Build (push) Successful in 43s Details
2024-10-25 01:02:13 +02:00
Sven Vogel 407a143729 fix(readme): fixed invalid `img` tag
Gitea Vite Build Action / Vite-Build (push) Successful in 41s Details
2024-10-24 22:59:52 +00:00
Sven Vogel 7c38e77329 feat(readme): added preview image
Gitea Vite Build Action / Vite-Build (push) Successful in 41s Details
2024-10-25 00:56:59 +02:00
Sven Vogel e84f97d9b7 fix(readme): fixed spelling mistake
Gitea Vite Build Action / Vite-Build (push) Successful in 41s Details
2024-10-25 00:52:46 +02:00
Sven Vogel c3b2daab62 fix(readme): centered banner image 2024-10-25 00:51:25 +02:00
Sven Vogel 8acf99bcc1 refactor(readme): updated readme
Gitea Vite Build Action / Vite-Build (push) Successful in 39s Details
Added section to readme:
- getting started
- technology stack
- docker container

Adjusted banner to take up 60% of width
2024-10-25 00:49:57 +02:00
Sven Vogel 6b3da418f7 refactor(readme): changed banner text color to white 2024-10-25 00:37:29 +02:00
Sven Vogel 67902044ca Merge pull request 'feat(docker): added multi stage dockerfile' (#4) from feat/docker-image into main
Gitea Vite Build Action / Vite-Build (push) Successful in 42s Details
Reviewed-on: #4
2024-10-24 22:35:18 +00:00
Sven Vogel 2e3c69b550 feat(docker): added multi stage dockerfile
Gitea Vite Build Action / Vite-Build (push) Successful in 41s Details
2024-10-25 00:34:53 +02:00
Sven Vogel 077d3ef8e9 Merge pull request 'feat/add-three.js' (#3) from feat/add-three.js into main
Gitea Vite Build Action / Vite-Build (push) Successful in 40s Details
Reviewed-on: #3
2024-10-24 22:16:31 +00:00
5 changed files with 93 additions and 18 deletions

12
Dockerfile Normal file
View File

@ -0,0 +1,12 @@
FROM node:20 AS builder
COPY . /brunsviga
WORKDIR /brunsviga
RUN npm ci
RUN npm run build
FROM nginx:mainline-alpine3.20-slim as runtime
COPY --from=builder /brunsviga/dist /usr/share/nginx/html/
RUN chown -R 1000:1000 /usr/share/nginx/html/

8
LICENSE Normal file
View File

@ -0,0 +1,8 @@
Copyright 2024 Sven Vogel
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -1,2 +1,52 @@
<img alt="banner" src="./assets/brunsviga_banner.svg" width="100%"/> <div align="center">
<img alt="banner" src="./assets/brunsviga_banner.svg" width="60%"/>
<br>
<h2>Technology demonstration for 3D simulation of Brunsviga RK 13</h2>
</div>
<div align="center" >
<img src="./assets/preview.png" alt="preview" width="60%"/>
</div>
---
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).
## ☁️ 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
```

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 112 KiB

After

Width:  |  Height:  |  Size: 109 KiB

BIN
assets/preview.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB