Skip to content

Commit 682dee3

Browse files
authored
Revise README with project details and badges
Updated README.md to include project description and features.
1 parent 82a7bc8 commit 682dee3

1 file changed

Lines changed: 132 additions & 37 deletions

File tree

README.md

Lines changed: 132 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,154 @@
1-
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
1+
# SIST (Ship Intelligence & Suspicion Tracker)
22

3-
<p align="center">
4-
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
5-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
6-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
7-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
8-
</p>
3+
![](https://img.shields.io/github/stars/tristanbudd/sist.svg)
4+
![](https://img.shields.io/github/watchers/tristanbudd/sist.svg)
5+
![](https://img.shields.io/github/license/tristanbudd/sist.svg)
96

10-
## About Laravel
7+
![](https://img.shields.io/github/issues-raw/tristanbudd/sist.svg)
8+
![](https://img.shields.io/github/issues-closed-raw/tristanbudd/sist.svg)
9+
![](https://img.shields.io/github/issues-pr-raw/tristanbudd/sist.svg)
10+
![](https://img.shields.io/github/issues-pr-closed-raw/tristanbudd/sist.svg)
1111

12-
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
12+
SIST (Ship Intelligence & Suspicion Tracker) - A modern AIS monitoring and analysis platform designed to detect suspicious vessel activity, anomalies, and patterns in maritime data.
1313

14-
- [Simple, fast routing engine](https://laravel.com/docs/routing).
15-
- [Powerful dependency injection container](https://laravel.com/docs/container).
16-
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
17-
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
18-
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
19-
- [Robust background job processing](https://laravel.com/docs/queues).
20-
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
14+
---
2115

22-
Laravel is accessible, powerful, and provides tools required for large, robust applications.
16+
## Project Description
2317

24-
## Learning Laravel
18+
SIST provides a powerful interface for tracking, analysing, and flagging vessel behaviour using AIS (Automatic Identification System) data.
2519

26-
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. You can also check out [Laravel Learn](https://laravel.com/learn), where you will be guided through building a modern Laravel application.
20+
The platform is built with a Laravel backend and a React + Inertia.js frontend, offering a fast, responsive, and scalable architecture for real-time maritime intelligence.
2721

28-
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
22+
It aims to support:
23+
- Monitoring vessel movement and behaviour.
24+
- Detecting anomalies and suspicious activity.
25+
- Visualising maritime data in a clear, actionable way.
26+
- Providing a foundation for further intelligence tooling.
2927

30-
## Laravel Sponsors
28+
---
3129

32-
We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
30+
## Features
31+
[TO BE COMPLETED]
3332

34-
### Premium Partners
33+
---
3534

36-
- **[Vehikl](https://vehikl.com)**
37-
- **[Tighten Co.](https://tighten.co)**
38-
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
39-
- **[64 Robots](https://64robots.com)**
40-
- **[Curotec](https://www.curotec.com/services/technologies/laravel)**
41-
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
42-
- **[Redberry](https://redberry.international/laravel-development)**
43-
- **[Active Logic](https://activelogic.com)**
35+
## Preview
36+
37+
[TO BE COMPLETED]
38+
39+
---
40+
41+
## Tech Stack
42+
43+
- **Backend:** Laravel (PHP ≥ 8.3)
44+
- **Frontend:** React 18 + Inertia.js
45+
- **Build Tooling:** Vite
46+
- **Styling:** Tailwind CSS
47+
- **Linting & Formatting:** ESLint, Prettier, Laravel Pint
48+
- **Git Hooks:** Husky + lint-staged
49+
50+
---
51+
52+
## Installation & Setup
53+
54+
### 1. Clone the repository
55+
```bash
56+
git clone https://github.com/tristanbudd/sist.git
57+
cd sist
58+
```
59+
### 2. Install dependencies
60+
61+
#### PHP dependencies
62+
```bash
63+
composer install
64+
```
65+
#### Node dependencies (pnpm)
66+
```bash
67+
pnpm install
68+
```
69+
### 3. Environment setup
70+
```bash
71+
cp .env.example .env
72+
73+
Update your .env file:
74+
75+
APP_NAME=SIST
76+
APP_ENV=local
77+
78+
DB_CONNECTION=mysql
79+
DB_HOST=127.0.0.1
80+
DB_PORT=3306
81+
DB_DATABASE=sist
82+
DB_USERNAME=root
83+
DB_PASSWORD=
84+
```
85+
86+
### 4. Generate app key
87+
```bash
88+
php artisan key:generate
89+
```
90+
### 5. Run migrations
91+
```bash
92+
php artisan migrate
93+
```
94+
### 6. Start development servers
95+
96+
# Laravel backend
97+
```bash
98+
php artisan serve
99+
```
100+
101+
# Frontend (Vite)
102+
```bash
103+
pnpm dev
104+
```
105+
---
106+
107+
## Scripts
108+
```bash
109+
pnpm dev # Start Vite dev server
110+
pnpm build # Build frontend assets
111+
112+
pnpm lint # Run ESLint
113+
pnpm lint:fix # Fix lint issues
114+
115+
pnpm format # Format frontend files
116+
pnpm format:check # Check formatting
117+
118+
pnpm format:php # Format PHP (Laravel Pint)
119+
pnpm format:php:test # Check PHP formatting
120+
```
121+
---
122+
123+
## Development Notes
124+
125+
- Uses modern Laravel + Inertia architecture (SPA without full API separation)
126+
- Frontend is located in resources/js
127+
- Tailwind CSS is configured via Vite
128+
- Husky + lint-staged enforce code quality on commits
129+
130+
---
44131

45132
## Contributing
46133

47-
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
134+
Contributions are welcome.
135+
136+
1. Fork the repository
137+
2. Create a feature branch
138+
3. Commit your changes
139+
4. Ensure linting and formatting pass
140+
5. Open a pull request
141+
142+
Please read [CONTRIBUTING.md](https://github.com/tristanbudd/sist/blob/main/CONTRIBUTING.md) for more details.
48143

49-
## Code of Conduct
144+
---
50145

51-
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
146+
## Security
52147

53-
## Security Vulnerabilities
148+
If you discover a vulnerability, please open a private issue or follow [SECURITY.md](https://github.com/tristanbudd/sist/blob/main/SECURITY.md).
54149

55-
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
150+
---
56151

57152
## License
58153

59-
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
154+
[MIT](LICENSE)

0 commit comments

Comments
 (0)