-
Notifications
You must be signed in to change notification settings - Fork 0
- Update readme #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
4f8b116
- Init
AmonDeShir 4d455d1
merge init
AmonDeShir ed7fa43
Update .github/workflows/test-and-lint-js.yml
AmonDeShir a800a27
Change app urls
AmonDeShir 01a4a3e
Merge branch 'init' of https://github.com/MRR-Group/MiniStrava-API in…
AmonDeShir 503855a
add tsx
AmonDeShir fdb12ba
fix packages names
AmonDeShir 9c517ae
fix composer lock
AmonDeShir a703c59
fix code style
AmonDeShir 543b794
Add redis
AmonDeShir 68e355c
Add vite port to .env
AmonDeShir 5b1163e
update readme
AmonDeShir ef624aa
Merge branch 'main' of https://github.com/MRR-Group/MiniStrava-API in…
AmonDeShir 93ad2a8
Update readme.md
AmonDeShir File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.