docs: overwrite README with project description and centered preview image
All checks were successful
Deploy to Production / deploy (push) Successful in 6s
All checks were successful
Deploy to Production / deploy (push) Successful in 6s
This commit is contained in:
40
README.md
40
README.md
@@ -1,31 +1,21 @@
|
||||
# Vue 3 + Vite
|
||||
# Rubik's Cube Logic Engine & Simulator
|
||||
|
||||
This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
|
||||
<div align="center">
|
||||
<img src="./public/preview.png" alt="Cube Preview" width="600" />
|
||||
</div>
|
||||
|
||||
Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).
|
||||
## Overview
|
||||
|
||||
## Uruchamianie (Automatyczne - CI/CD)
|
||||
This application is a 3D animated, Interactive Rubik's Cube simulator and mathematical solver built from scratch using Vue.js. It aims to provide seamless mechanical interactions and mathematically perfectly rigorous tracking of a classic 3x3 Rubik's Cube state.
|
||||
|
||||
Projekt wykorzystuje **Gitea Actions** z runnerem **self-hosted** na serwerze produkcyjnym.
|
||||
Każdy push do gałęzi `main` automatycznie:
|
||||
1. Pobiera kod na serwerze.
|
||||
2. Zatrzymuje i usuwa stare kontenery.
|
||||
3. Buduje i uruchamia nową wersję aplikacji przy użyciu `docker compose up -d --build`.
|
||||
The software operates entirely in the browser using a custom Group Theory mathematical engine (`DeepCube.js`), which separates the heavy analytical permutation tracking from the 3D CSS visual layer using Web Workers.
|
||||
|
||||
### Konfiguracja Sieci i Bezpieczeństwa (Izolacja)
|
||||
## Features
|
||||
|
||||
Aplikacja wykorzystuje dwie sieci dockerowe dla zapewnienia izolacji:
|
||||
1. `npm_public` (zewnętrzna): Sieć, w której znajduje się Nginx Proxy Manager. Tylko kontener `rubic-cube` jest do niej podłączony, aby NPM mógł przekierować ruch.
|
||||
2. `rubic-net` (wewnętrzna): Prywatna sieć aplikacji. Wszelkie inne serwisy (np. baza danych, redis - jeśli dodasz w przyszłości) powinny być tylko w tej sieci, niewidoczne dla NPM ani innych aplikacji.
|
||||
|
||||
**Wymagania:**
|
||||
Przed uruchomieniem upewnij się, że na serwerze istnieje sieć publiczna dla proxy:
|
||||
```bash
|
||||
docker network create npm_public
|
||||
```
|
||||
(Jeśli Twój Nginx Proxy Manager używa innej sieci, zaktualizuj nazwę w `docker-compose.yml`).
|
||||
|
||||
W panelu Nginx Proxy Manager skonfiguruj:
|
||||
* **Network:** `npm_public` (lub odpowiednia sieć proxy).
|
||||
* **Forward Hostname:** `rubic-cube`
|
||||
* **Forward Port:** `80`
|
||||
- **Mechanical Realism:** 3D CSS rendering precisely models physical cube mechanics. Dragging edge and corner pieces rotates the specific mechanical layer dynamically, while dragging the center elements pivots the entire camera view.
|
||||
- **Reactive Algorithm Queue:** Execute complex algorithms fluidly. The dynamic queue evaluates incoming inputs and instantly intercepts redundances (e.g. evaluating `U U` into a single `U2` animation, or cancelling out `F` into `F'` on the fly).
|
||||
- **Deep Mathematical Engine:** Based entirely on Group Theory. It stores corner and edge permutation arrays combined with spatial orientation parities to guarantee that only physically legal mechanical states exist or can be scrambled.
|
||||
- **Intelligent Solvers:**
|
||||
- **Beginner Method (Human):** Constructs the solution layer-by-layer simulating human heuristics natively with instantaneous $O(1)$ algorithmic macros.
|
||||
- **Kociemba's Algorithm (Optimal):** Offloads pruning tables and recursive heuristic searches to Web Workers to instantly calculate and stream back the objectively shortest path solution (typically <20 moves).
|
||||
- **High Performance:** Decoupling the single-threaded UI rendering stack from mathematical validations ensures 60 FPS 3D animations, even while executing computationally expensive analytical algorithms in the background.
|
||||
|
||||
31
index.html
31
index.html
@@ -1,13 +1,32 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<link rel="icon" type="image/svg+xml" href="/src/assets/rubic-cube.svg" />
|
||||
<link rel="icon" type="image/svg+xml" href="/cube.svg" />
|
||||
<link rel="icon" type="image/png" href="/favicon.png" sizes="32x32" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Rubic Cube</title>
|
||||
</head>
|
||||
<body>
|
||||
<title>Rubic Cube Logic Engine</title>
|
||||
|
||||
<meta name="description"
|
||||
content="A 3D interactive Rubik's Cube simulator and solver powered by a custom mathematical engine." />
|
||||
<!-- Open Graph (for social media sharing like Facebook/Discord) -->
|
||||
<meta property="og:title" content="Rubic Cube Logic Engine" />
|
||||
<meta property="og:description"
|
||||
content="A 3D interactive Rubik's Cube simulator and solver powered by a custom mathematical engine." />
|
||||
<meta property="og:image" content="/preview.png" />
|
||||
<meta property="og:type" content="website" />
|
||||
<!-- Twitter Cards -->
|
||||
<meta name="twitter:card" content="summary_large_image" />
|
||||
<meta name="twitter:title" content="Rubic Cube Logic Engine" />
|
||||
<meta name="twitter:description"
|
||||
content="A 3D interactive Rubik's Cube simulator and solver powered by a custom mathematical engine." />
|
||||
<meta name="twitter:image" content="/preview.png" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="app"></div>
|
||||
<script type="module" src="/src/main.js"></script>
|
||||
</body>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
||||
1211
package-lock.json
generated
1211
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -15,6 +15,7 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@vitejs/plugin-vue": "^5.2.1",
|
||||
"puppeteer": "^24.37.5",
|
||||
"vite": "^6.2.0"
|
||||
}
|
||||
}
|
||||
|
||||
1
public/cube.svg
Normal file
1
public/cube.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 8.1 KiB |
BIN
public/favicon.png
Normal file
BIN
public/favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
BIN
public/preview.png
Normal file
BIN
public/preview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 72 KiB |
Reference in New Issue
Block a user