updated readme

This commit is contained in:
2025-11-11 13:52:58 +00:00
parent ee3e111e9b
commit e374456588
3 changed files with 40 additions and 28 deletions

View File

@@ -2,58 +2,68 @@
This is a React-based web application built with Vite (react and typescript).
## Getting started
### Prerequisites
- Node.js (v18 or higher recommended)
- Yarn (v1.22+) (https://yarnpkg.com/)
### Installation
```bash
git clone https://mavportal.com/TobaOjo/Mav-Mobile-UI.git
cd Mav-Mobile-UI
yarn install
```
### Running Locally
```bash
yarn dev
```
The app will be available at `http://localhost:5173`.
To run on locally on other devices
```bash
yarn dev --host
```
The app will be available at the exposed addresses to access e.g. http://192.168.0.123:5173/Mobile
The app will be available at the exposed addresses to access e.g. http://1xx.xxx.x.xxx:<PORT>/Mobile
## Tech Stack
- **React** UI library
- **Vite** Build tool
- **Yarn** Package manager
## Configuration
Create a `.env` file to access the Mav Mobile box in unit 5 for or for any environment-specific settings:
```env
VITE_AGX_BOX_URL=http://100.118.196.113:8080
VITE_AGX_BOX_URL=http://1xx.xxx.xxx.xxx:<PORT>
```
## 🧪 Development
## Development
### Linting & Formatting
```bash
yarn lint
yarn format
```
### Testing
(Currently not implemented consider adding Jest or Vitest)
## 🚢 Deployment
## Deployment
To build for production:
```bash
yarn build
```
@@ -65,13 +75,13 @@ Log into box on Moba using Session > SSH and putting IP in Remote Host.
Creds are mav:mav
Drag and drop dist.zip into file explorer menu on left hand side (has to be named dist.zip exactly).
Run command
```bash
sudo ./integrate-web-ui.sh
```
Run
```bash
sudo nano web-static/index.html
```

BIN
dist.zip Normal file

Binary file not shown.

View File

@@ -160,12 +160,13 @@ const SightingModal = ({ isSightingModalOpen, handleClose, sighting, onDelete }:
<dd className="font-medium text-2xl">{sighting?.seenCount ?? "-"}</dd>
</div>
{sighting?.make && (
<div>
<dt className="text-gray-300">Make</dt>
<dd className="font-medium text-2xl">{sighting?.make ?? "-"}</dd>
</div>
)}
{sighting?.make ||
(sighting?.make.trim() && (
<div>
<dt className="text-gray-300">Make</dt>
<dd className="font-medium text-2xl">{sighting?.make ?? "-"}</dd>
</div>
))}
{sighting?.model ||
(!sighting?.model.trim() && (
<div>
@@ -173,12 +174,13 @@ const SightingModal = ({ isSightingModalOpen, handleClose, sighting, onDelete }:
<dd className="font-medium text-2xl">{sighting?.model ?? "-"}</dd>
</div>
))}
{sighting?.color && (
<div className="sm:col-span-2">
<dt className="text-gray-300">Colour</dt>
<dd className="font-medium text-2xl">{sighting?.color ?? "-"}</dd>
</div>
)}
{sighting?.color ||
(!sighting?.color.trim() && (
<div className="sm:col-span-2">
<dt className="text-gray-300">Colour</dt>
<dd className="font-medium text-2xl">{sighting?.color ?? "-"}</dd>
</div>
))}
<div>
<dt className="text-gray-300">Time</dt>