🚴‍♂️ Rodada Libre API

🇪🇸 Español: Lee este documento en español aquí.

RESTful Backend designed for the Rodada Libre, mobile app, soon available on the Google Play Store. This API handles geospatial services for urban cyclists, secure authentication, and a collaborative content moderation system.

📋 Table of Contents

• Architecture & Workflow
• Tech Stack
• Local Installation
• Security & Roles

🏗 Architecture & Workflow

The core of the system ensures data integrity for geospatial points. To guarantee quality without hindering user contributions, we implemented an Asynchronous Moderation Pattern (Change Request Pattern):

graph TD
    User((Cyclist)) -->|POST /places| API{Has Role?}
    API -- "No (User)" --> DB1[(ChangeRequests)]
    API -- "Yes (Mod/Admin)" --> DB2[(Places)]
    
    DB1 -->|Pending| Moderator((Moderator))
    Moderator -->|Approve| DB2
    Moderator -->|Reject| Trash[Trash / Cleanup]

Loading

Key Features

Upload First Strategy: Decoupled image uploading to optimize UX on unstable mobile networks.

Soft Deletes: Prevention of accidental data loss for critical entities (Users, Places, Photos).

Role-Based Access Control (RBAC): Granular permission management using Spatie.

🛠 Tech Stack

• Core: Laravel 12 / PHP 8.2+

• Database: MySQL 8.0

• Authentication: JWT (tymon/jwt-auth)

• Authorization RBAC: (spatie/laravel-permission)

💻 Local Installation

Requirements: PHP 8.2, Composer, MySQL.

1.- Clone and prepare

git clone https://github.com/rodrigocarreonc/RodadaLibreAPI.git
cd RodadaLibreAPI
composer install
cp .env.example .env

2.-Database Configuration

Edit .env file with your local credentials (DB_DATABASE, etc).

3.-Generate Keys

php artisan key:generate
php artisan jwt:secret
php artisan storage:link

4.-Migrations y Seeders

Edit .env and add the environment variables for each user, moderator, and administrator credential

# Seed admin details
SEED_ADMIN_NAME="admin_name"
SEED_ADMIN_EMAIL="admin@example.com"
SEED_ADMIN_PASSWORD="admin123"

SEED_MODERATOR_NAME="moderator_name"
SEED_MODERATOR_EMAIL="mod@example.com"
SEED_MODERATOR_PASSWORD="mod123"

SEED_USER_NAME="user_name"
SEED_USER_EMAIL="user@example.com"
SEED_USER_PASSWORD="user123"

Y run migration and seeders

php artisan migrate --seed
# This creates initial places and the roles of a user, moderator, and administrator.

🛡 Security & Roles

The system uses RBAC (Role-Based Access Control).

Role	Permissions
User	View map, Suggest places (goes to moderation queue).
Moderator	View map, Create/Edit places directly, Approve requests.
Admin	All of the above + Manage users and assign roles.

📄 License

Proprietary software owned by José Rodrigo Carreón Cardona. All rights reserved.