Added project readme

2025-10-24 19:24:00 +02:00
parent 0240efe911
commit b89d9690ed
5 changed files with 90 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,90 @@
+# Kiosk
+
+A modern office/building information display system built with React and PocketBase. Provides an interactive interface for building navigation, company directory, and bulletin notices.
+
+## Features
+
+- **Interactive Floor Plans** - Navigate multi-story buildings with annex filtering, room highlighting, and company logo positioning
+- **Company Directory** - Browse tenant companies with contact information and visual cards
+- **Bulletin Board** - Display important notices and announcements
+- **Static Hosting Ready** - Hash-based routing for deployment anywhere
+
+## Screenshots
+
+### Bulletin Board
+![Bulletin Board](media/Screen%20Shot%202025-10-24%20at%2019.06.12-fullpage.png)
+
+### Company Directory
+![Company Directory](media/Screen%20Shot%202025-10-24%20at%2019.11.06-fullpage.png)
+
+### Floor Plan Navigation
+![Floor Plan Navigation](media/Screen%20Shot%202025-10-24%20at%2019.18.46-fullpage.png)
+
+### About Page
+![About Page](media/Screen%20Shot%202025-10-24%20at%2019.21.03-fullpage.png)
+
+## Setup
+
+### Prerequisites
+
+- **pnpm** 8+ (package manager)
+- **PocketBase** (backend database)
+
+### PocketBase Setup
+
+1. Download PocketBase from [pocketbase.io](https://pocketbase.io)
+2. Initialize the database:
+   ```bash
+   ./pocketbase serve
+   ```
+3. Import the schema from `schema/pb_schema.json` via the PocketBase admin UI (_Settings > Import collections_)
+
+### Web Frontend
+
+Install dependencies:
+```bash
+cd web
+pnpm install
+```
+
+#### Development Mode
+
+Run the development server:
+```bash
+make web-dev
+# or
+cd web && pnpm dev
+```
+
+The app will be available at `http://localhost:5173`
+
+#### Production Build
+
+Build for production:
+```bash
+make web-build
+# or
+cd web && pnpm build
+```
+
+Built files will be in `web/dist/` - ready for static hosting.
+
+### Additional Commands
+
+```bash
+make web-lint      # Run ESLint
+make web-format    # Format code with Prettier
+make web-preview   # Preview production build
+```
+
+## Tech Stack
+
+- **Frontend**: React 19, TypeScript, Vite, Tailwind CSS
+- **UI Components**: shadcn/ui
+- **Routing**: Wouter (hash-based)
+- **Backend**: PocketBase
+- **Build**: Vite with Rolldown (beta)
+
+## License
+
+MIT License - Copyright © 2025 "NABLA" d.o.o. Zenica