From 2b164d6525ec44d64c60f00e19cfdc08868019b9 Mon Sep 17 00:00:00 2001 From: Denis Urs Rudolph Date: Thu, 11 Dec 2025 21:44:37 +0100 Subject: [PATCH] Added Readme.md --- README.md | 60 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index e215bc4..5486c18 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,34 @@ -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). +# OTA Fleet Dashboard + +The management interface for the OTA Fleet System. Built with Next.js to provide real-time visibility and control over the fleet. + +## Tech Stack +* **Next.js**: React framework for production. +* **Tailwind CSS**: Utility-first CSS framework for styling. +* **Bun**: Fast JavaScript runtime and package manager. +* **Lucide React**: Icon set. + +## Features +* **Fleet Overview**: + * Grouped view of all vehicles. + * Real-time status tracking (Online/Offline) with 5s timeout logic. + * Version distribution stats per group. + * Collapsible groups for easier navigation. +* **Group Manager**: Create groups and assign vehicles via a modal interface. +* **Update Manager**: Upload firmware (`.bin` files) and deploy them to targets. ## Getting Started -First, run the development server: +1. **Install Dependencies**: + ```bash + bun install + ``` -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +2. **Run Development Server**: + ```bash + bun run dev + ``` + Open [http://localhost:3000](http://localhost:3000) in your browser. -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -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. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [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. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! - -## Deploy on Vercel - -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. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +## Configuration +* **API Proxy**: Requests to `/api/*` are forwarded to the backend (check `next.config.ts` or manually configured in `lib/api.ts` if using direct URL). Currently, `lib/api.ts` points to `http://localhost:5000`.