Skip to content
47 changes: 10 additions & 37 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,14 @@
## @blumilksoftware/MiniStravaAPI
### About application
> placeholder
# @MRR/MiniStravaAPI

### Local development
```
## About
MiniStrava is a lightweight fitness-tracking system composed of a mobile app (Android/iOS), a web admin panel, and a REST API. Users record runs, rides, and walks with GPS; view routes, pace, distance, and basic stats; name activities, add notes/photos, and browse/filter history with weekly leaderboards. Admins manage users and activities and see global stats. The API includes OpenAPI docs at /api/documentation and supports GPX export (with optional CSV export and push notifications).

## Stack
- Laravel 11
- PostgreSQL
- Redis

## Local development
cp .env.example .env
task init
task vite
```
Application will be running under [localhost:83851](localhost:83851) and [http://MiniStravaAPI.blumilk.localhost/](http://MiniStravaAPI.blumilk.localhost/) in Blumilk traefik environment. If you don't have a Blumilk traefik environment set up yet, follow the instructions from this [repository](https://github.com/blumilksoftware/environment).

#### Commands
Before running any of the commands below, you must run shell:
```
make shell
```

| Command | Task |
|:------------------------|:--------------------------------------------|
| `composer <command>` | Composer |
| `composer test` | Runs backend tests |
| `composer analyse` | Runs Larastan analyse for backend files |
| `composer cs` | Lints backend files |
| `composer csf` | Lints and fixes backend files |
| `php artisan <command>` | Artisan commands |
| `npm run dev` | Compiles and hot-reloads for development |
| `npm run build` | Compiles and minifies for production |
| `npm run lint` | Lints frontend files |
| `npm run lintf` | Lints and fixes frontend files |
| `npm run tsc` | Runs TypeScript checker |


#### Containers

| service | container name | default host port |
|:-----------|:--------------------------|:--------------------------------|
| `app` | `MiniStravaAPI-app-dev` | [83851](http://localhost:83851) |
| `database` | `MiniStravaAPI-db-dev` | 83853 |
| `redis` | `MiniStravaAPI-redis-dev` | 83852 |
| `mailpit` | `MiniStravaAPI-mailpit-dev` | 83854 |