|
| 1 | +# Antares Web |
| 2 | + |
| 3 | +**Antares Web** is a browser-based radar visualization and simulation control interface, part of the broader [ANTARES platform](https://thesoftwaredesignlab.github.io/ANTARES/). It connects to live radar data streams via WebSocket and provides tools to visualize tracks, issue commands, and configure scenarios in real-time. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +### Installation |
| 8 | + |
| 9 | +```bash |
| 10 | +npm install |
| 11 | +``` |
| 12 | + |
| 13 | +### Development Server |
| 14 | + |
| 15 | +```bash |
| 16 | +npm run dev |
| 17 | +``` |
| 18 | + |
| 19 | +The app will start on [http://localhost:8080/](http://localhost:8080/) by default. |
| 20 | + |
| 21 | +## Project Structure |
| 22 | + |
| 23 | +This project is part of a monorepo. Below is a brief description of the main folders and files in `antares-web`: |
| 24 | + |
| 25 | +``` |
| 26 | +antares-web/ |
| 27 | +├── src/ # Main application source code |
| 28 | +│ ├── api/ # HTTP/WebSocket API interactions |
| 29 | +│ ├── components/ # UI components |
| 30 | +│ │ ├── ships/ # Ship creation and configuration UI |
| 31 | +│ │ └── ui/ # Reusable UI primitives (modals, toasts, etc.) |
| 32 | +│ ├── contexts/ # React context providers (e.g., config, WebSocket) |
| 33 | +│ ├── hooks/ # Custom React hooks |
| 34 | +│ ├── lib/ # Generic utility functions |
| 35 | +│ ├── pages/ # Route-based page components |
| 36 | +│ ├── types/ # Type definitions (e.g., Track data) |
| 37 | +│ └── utils/ # Radar-specific data parsers and validators |
| 38 | +├── public/ # Static assets |
| 39 | +├── config.example.toml # Example runtime config for ANTARES |
| 40 | +├── template.env # Example environment variables |
| 41 | +├── vite.config.ts # Vite configuration |
| 42 | +└── tailwind.config.ts # Tailwind CSS configuration |
| 43 | +``` |
| 44 | + |
| 45 | +## Learn More |
| 46 | + |
| 47 | +For demos, videos, and more information about the platform and its capabilities, visit the official project site: |
| 48 | +👉 [https://thesoftwaredesignlab.github.io/ANTARES/antares-web](https://thesoftwaredesignlab.github.io/ANTARES/antares-web) |
| 49 | + |
| 50 | +If you are interested in contributing or exploring the rest of the ANTARES simulation stack, check out the full monorepo: |
| 51 | +👉 [https://github.com/TheSoftwareDesignLab/ANTARES](https://github.com/TheSoftwareDesignLab/ANTARES) |
| 52 | + |
| 53 | +## Credits |
| 54 | + |
| 55 | +This project was bootstrapped using [Lovable](https://lovable.dev/). |
0 commit comments