Ostrzołka Wiki Engine

PL: Silnik wiki dedykowany projektowi Ostrzółka.
EN: A dedicated wiki engine for the Ostrzółka project.

---

🇵🇱 Język Polski

O projekcie

Ostrzołka Wiki to warstwa oprogramowania napędzająca platformę informacyjną o historii Bydgoszczy. Repozytorium to zawiera kod źródłowy, architekturę interfejsu oraz logikę zarządzania treścią.

⚠️ Ważna uwaga: To repozytorium dotyczy wyłącznie silnika wiki (kodu źródłowego). Dane historyczne, wpisy archiwalne oraz pliki multimedialne są przechowywane i zarządzane w ramach oddzielnego projektu bazy danych.

Instalacja i Uruchomienie

1. Sklonuj repozytorium:

   git clone https://github.com/ostrzolka/wiki.git

2. Zainstaluj zależności:

   bun install

3. Uruchom serwer deweloperski:

   bun run dev

Kontrybucja

Jeśli chcesz pomóc w rozwoju kodu silnika (poprawa wydajności, nowe moduły wizualizacji), zapoznaj się z plikiem CONTRIBUTING.md. Poprawki błędów i propozycje nowych funkcji są zawsze mile widziane.

---

🇬🇧 English

About the Project

Ostrzołka Wiki is the software layer powering the information platform for Bydgoszcz's history. This repository contains the source code, UI architecture, and content management logic.

⚠️ Note: This repository is strictly for the wiki engine (source code). Historical data, archival entries, and media files are stored and managed within a separate database project.

Setup and Installation

1. Clone the repository:

   git clone https://github.com/ostrzolka/wiki.git

2. Install dependencies:

   bun install

3. Run the development server:

   bun run dev

Contributing

If you wish to contribute to the engine's development (performance improvements, new visualization modules), please refer to the CONTRIBUTING.md file. Bug fixes and feature requests are always welcome!

---

License / Licencja

This project is licensed under the MIT License.