Skip to content

Kimchiigu/VorteKia

Repository files navigation

VorteKia 🎡⛲

VorteKia Logo

Amusement Park World Desktop App — Built with Tauri, Rust, React, and more.


VorteKia: Amusement Park Desktop App 🎡🖥️

VorteKia is a cross-platform desktop application developed using Tauri, Rust, React, Vite, Tailwind CSS, and Three.js. It serves as an interactive amusement park management system with features for customer interactions, souvenir purchases, and immersive 3D visuals.


🧭 Table of Contents

  1. Project Overview
  2. Mockup Screenshot
  3. Technology Stack
  4. Prerequisites
  5. How to Run Locally
  6. Database & Caching Setup

📌 Project Overview

  • Name: VorteKia
  • Type: Desktop Application
  • Purpose: Built for TPA Lab Assistant @ BINUS University
  • Focus: Local amusement park simulation, souvenir store, and customer interaction platform.
  • Lore: Here's the full lore of how VorteKia is!

    VorteKia Logo


📸 Mockup Screenshot

Coming Soon


⚙️ Technology Stack

💻 Core Technologies

  • Rust — Backend logic & Tauri bridge
  • Tauri — Lightweight desktop application runtime
  • React (w/ Vite) — Frontend UI
  • Tailwind CSS — Styling
  • Three.js — 3D park visualization

🗃️ Data & Infrastructure

  • PostgreSQL — Primary database
  • Redis — Local cache layer
  • SeaORM — ORM for Rust

✅ Prerequisites

Make sure these tools are installed:


🚀 How to Run Locally

1. Clone the Repository

git clone https://github.com/Kimchiigu/VorteKia.git
cd vortekia

2. Install Dependencies

npm install

3. Copy .env.example to .env (Create new .env file)

Fill the blanks with your API Key and PostgreSQL Connections

DATABASE_URL=protocol://username:password@host/database
REDIS_URL=redis://127.0.0.1:6379
FIREBASE_API_KEY=
FIREBASE_AUTH_DOMAIN=
FIREBASE_PROJECT_ID=
FIREBASE_STORAGE_BUCKET=
FIREBASE_MESSAGING_SENDER_ID=
FIREBASE_APP_ID=
FIREBASE_MEASUREMENT_ID=

4. Run the App in Dev Mode

npm run tauri dev

🗄️ Database & Caching Setup

PostgreSQL with SeaORM

  1. Navigate to Tauri backend:

    cd src-tauri
  2. Run migrations:

    sea-orm-cli migrate up

    Or for fresh start:

    sea-orm-cli migrate fresh
  3. Generate entities:

    sea-orm-cli generate entity -o entity/src/

Redis (Run via WSL if on Windows)

  1. Launch WSL:

    wsl
  2. Start Redis server:

    sudo service redis-server start
  3. Test Redis CLI:

    redis-cli

    Should return:

    127.0.0.1:6379> ping
    PONG

📬 Contact / Issues

Feel free to open issues or contact me if you need help setting it up!


Made with 💙 for the BINUS Lab Assistant TPA Final Project.

Releases

No releases published

Packages

 
 
 

Contributors

Languages