Skip to content

Commit 6368ef9

Browse files
authored
Merge pull request #178 from tristanbudd/create-llms-txt
Add LLMS.TXT
2 parents 77a29e2 + 0c3e962 commit 6368ef9

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

public/llms.txt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# SIST (Ship Intelligence & Suspicion Tracker)
2+
> A modern AIS monitoring and analysis platform designed to detect suspicious vessel activity, anomalies, and patterns in maritime data.
3+
4+
## Documentation & Links
5+
- [Main Application](https://sist.tristanbudd.com/): The main user interface for tracking and analyzing active vessels on a dynamic map.
6+
- [API Documentation](https://sist.tristanbudd.com/docs): Interactive API reference (Scalar) for building integrations and querying vessel data.
7+
- [GitHub Repository](https://github.com/tristanbudd/sist): Source code repository, setup guides, and contribution guidelines.
8+
9+
## Key Features
10+
- **Real-Time Fleet Tracking**: View active vessels globally on a high-performance interactive map.
11+
- **Hybrid Search**: Instant query response for finding active and offline vessels by name, MMSI, or callsign.
12+
- **Detailed Vessel Profiles**: Deep insights into vessel specifications, current voyage, and historical trajectory data.
13+
- **Sanctions & Compliance Verification**: Automatic cross-referencing against official sanction lists and dark fleet registries.
14+
- **Historical Trajectory Analysis**: Custom window tracking for visualizing past movement patterns and waypoints.
15+
16+
## API Reference (v1)
17+
All API endpoints are prefixed with `/api/v1/`.
18+
19+
### Status & Health
20+
- `GET /api/v1/status`: General status info.
21+
- `GET /api/v1/status/ready`: Health check / readiness endpoint.
22+
23+
### Environmental Conditions
24+
- `GET /api/v1/conditions/weather/{mmsi}`: Retrieve current weather conditions for the vessel's last reported coordinates.
25+
- `GET /api/v1/conditions/tides/{mmsi}`: Retrieve tidal information corresponding to the vessel's location.
26+
27+
### Vessels & Intelligence
28+
- `GET /api/v1/vessels`: Paginated list of active vessels.
29+
- `GET /api/v1/vessels/search`: Search vessels by search term.
30+
- `GET /api/v1/vessels/sanctioned/list`: List of flagged and sanctioned vessels.
31+
- `GET /api/v1/vessels/infractions`: List of recorded infractions.
32+
- `GET /api/v1/vessels/{mmsi}`: Detailed metadata and current status for a specific vessel.
33+
- `GET /api/v1/vessels/{mmsi}/history`: Historical trajectory data for trajectory analysis.
34+
- `GET /api/v1/vessels/{mmsi}/sanctions`: Check sanctions status for a specific vessel.
35+
- `GET /api/v1/vessels/{mmsi}/activities`: Activity log of vessel stops, speed anomalies, and dark activity.
36+
37+
## Architecture & Tech Stack
38+
- **Backend**: Laravel (PHP 8.3+) providing secure API services and data ingestion.
39+
- **Frontend**: React 18 + Inertia.js + Tailwind CSS, compiled using Vite.
40+
- **Database**: MySQL database storing vessel telemetry, metadata, and sanctions list data.
41+
- **API Docs**: Auto-generated OpenAPI specifications via Knuckles Scribe, interactive rendering by Scalar.

0 commit comments

Comments
 (0)