From 74aad4f3c9442032d115e78e9d809991bb085dee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Atakan=20Do=C4=9Fan=20=C3=96zban?= <1+atakan@noreply.git.atakanozban.com> Date: Mon, 6 Jul 2026 02:19:54 +0200 Subject: [PATCH] Update README.md --- README.md | 68 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 47 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index e215bc4..5e94cb8 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,62 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). +# Street View Gallery -## Getting Started +Street View Gallery is an enterprise-grade, geospatial visualization platform designed to present custom 360-degree panoramic street view imagery publicly accessible. Built with Next.js and Prisma, it serves as a secure, high-performance, independent alternative to commercial platform ecosystems. -First, run the development server: +The platform aims organizations and individuals to show their projects which recorded for Google Street View and makes it publicly accessible and explore from single lightweight UI. + +![Street View Gallery](https://www.atakanozban.com/Content/uploads/projects-media/e26b886af1cf4aaa9db76ce3a58e2f17.png) + +## Quick Start (Docker run) + +For evaluation or localized testing environments, execute the following command: ```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev +docker run -d -p 3000:3000 --name gsv_gallery atakanozban/gsv_gallery:latest ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## Production Deployment (Docker Compose) -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +For production-grade environments requiring data persistence, network isolation, and high availability, utilize the orchestrated configuration below: -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. +```yaml +services: + gsv_gallery: + image: atakanozban/gsv_gallery:latest + container_name: gsv_gallery + ports: + - "3000:3000" + environment: + - PORT=3000 + - DATABASE_URL=file:/app/data/prod.db + - GOOGLE_MAPS_API_KEY=YOUR_GOOGLE_MAPS_API_KEY_HERE + - ADMIN_USERNAME=admin + - ADMIN_PASSWORD=YOUR_SECURE_PASSWORD_HERE + - GOOGLE_CLIENT_ID=YOUR_GOOGLE_CLIENT_ID_HERE + - GOOGLE_CLIENT_SECRET=YOUR_GOOGLE_CLIENT_SECRET_HERE + volumes: + - ./data:/app/data + restart: unless-stopped +``` -## Learn More +# Configuration & Environment Variables +The platform utilizes environment variables for backend initialization. Ensure these are securely provisioned during container runtime orchestration: -To learn more about Next.js, take a look at the following resources: +| Variable | Description | Requirement | +| :--- | :--- | :--- | +| `DATABASE_URL` | The PostgreSQL connection string utilized by the Prisma ORM layer for transaction logs and metadata persistence. | **Required** | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +Note on Client-Side Integrations: The platform eliminates compile-time API dependencies. The Google Maps JavaScript API payload is resolved and securely injected via dynamic runtime state mechanics (/api/config) post-initialization. -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! +# Core Architecture & Features -## Deploy on Vercel +- Interactive Geospatial Dashboard: A unified, map-centric interface engineered to monitor, display, and review distinct panoramic tracks with optimized multi-layer rendering. -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +- Telemetry & GPX Integration: Automated, server-side parsed polyline extraction from standard GPX track logs, calculating accurate cumulative distances using high-precision spherical geometry algorithms. -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +- Synchronized Dual-View Navigation: Fully synchronized state management linking immersive, full-screen street view iframe panoramas with active tracking mini-maps. + +- Responsive Enterprise-Ready UI: Highly responsive web design layout optimized for both command-center displays and cross-platform mobile devices out of the box. + +# Support + +If you need more help with Street View Gallery, you can ask for support in [Gitea Issues](https://git.atakanozban.com/atakan/gsv_gallery/issues) or direct support through [mail](mailto:contact@atakanozban.com). This is the best source of answers, as both the n8n support team and community members can help.