Installation

System Requirements

Before installing MediaStream, ensure your system meets the following requirements:

PHP: ^8.2 or higher
Node.js: 18.x or higher
Composer: 2.x or higher
Database: SQLite (default) or MySQL/PostgreSQL

Installation Methods

Choose your preferred installation method:

Quick Setup (Recommended)
Manual Setup

Clone the repository

Clone the MediaStream repository to your local machine:

git clone https://github.com/OscarSPR/test-mediastream.git
cd test-mediastream

Run the setup script

MediaStream includes a convenient setup script that handles all installation steps:

composer run setup

This command will:

Install PHP dependencies via Composer
Copy .env.example to .env if it doesn’t exist
Generate application key
Run database migrations
Install Node.js dependencies
Build frontend assets

Start the development server

Launch all development services with a single command:

composer run dev

This starts:

Laravel development server on http://localhost:8000
Queue worker for background jobs
Laravel Pail for real-time logs
Vite dev server with HMR

The development server runs all services concurrently. Press Ctrl+C to stop all services at once.

Clone the repository

git clone https://github.com/OscarSPR/test-mediastream.git
cd test-mediastream

Install PHP dependencies

Install backend dependencies using Composer:

composer install

Key Dependencies:

laravel/framework: ^12.0
inertiajs/inertia-laravel: ^2.0
laravel/fortify: ^1.30 (Authentication)
laravel/tinker: ^2.10.1 (REPL)
laravel/wayfinder: ^0.1.9 (Routing)

Install Node.js dependencies

Install frontend dependencies:

npm install

Key Dependencies:

vue: ^3.5.13
@inertiajs/vue3: ^2.1.0
vite: ^7.0.4
tailwindcss: ^4.1.1
typescript: ^5.2.2
vee-validate: ^4.15.1
zod: ^3.25.76

Configure environment

Copy the example environment file:

cp .env.example .env

Generate application key:

php artisan key:generate

Set up database

MediaStream uses SQLite by default. Create the database file:

touch database/database.sqlite

Run migrations:

php artisan migrate

Build frontend assets

Build the Vue.js frontend:

npm run dev

Start the server

Start the Laravel development server:

php artisan serve

Access the application at http://localhost:8000

Development Dependencies

The following development tools are included:

Backend

laravel/sail: ^1.41 - Docker development environment
laravel/pail: ^1.2.2 - Real-time log viewer
laravel/pint: ^1.24 - PHP code style fixer
pestphp/pest: ^3.8 - Testing framework
mockery/mockery: ^1.6 - Mocking library

Frontend

@vitejs/plugin-vue: ^6.0.0 - Vue 3 plugin for Vite
typescript: ^5.2.2 - TypeScript support
eslint: ^9.17.0 - JavaScript linter
prettier: ^3.4.2 - Code formatter
tailwindcss: ^4.1.1 - Utility-first CSS framework

Optional: Docker Setup

MediaStream includes Laravel Sail for Docker-based development:

Install Sail

Sail is already included in the dependencies. Initialize it:

php artisan sail:install

Start containers

./vendor/bin/sail up -d

Run migrations

./vendor/bin/sail artisan migrate

Server-Side Rendering (Optional)

MediaStream supports SSR with Inertia.js:

Build SSR bundle

npm run build:ssr

Start with SSR

composer run dev:ssr

This starts the SSR server instead of the Vite dev server.

Verification

Verify your installation is successful:

Visit http://localhost:8000 in your browser
You should see the MediaStream welcome page
The registration and login links should be visible

If you see the welcome page, congratulations! MediaStream is now installed.

Troubleshooting

Permission errors

Ensure the storage and cache directories are writable:

chmod -R 775 storage bootstrap/cache

Database connection errors

Verify your database file exists:

ls -la database/database.sqlite

If using MySQL/PostgreSQL, check your .env database credentials.

Node.js build errors

Clear the npm cache and reinstall:

rm -rf node_modules package-lock.json
npm install

Port already in use

If port 8000 is taken, specify a different port:

php artisan serve --port=8080

Overview

Getting Started

Core Features

User Guide

Development

System Requirements

Installation Methods

Development Dependencies

Backend

Frontend

Optional: Docker Setup

Server-Side Rendering (Optional)

Verification

Troubleshooting

Next Steps

Quick Start

Configuration

Build docs developers (and LLMs) love

Overview

Getting Started

Core Features

User Guide

Development

​System Requirements

​Installation Methods

​Development Dependencies

​Backend

​Frontend

​Optional: Docker Setup

​Server-Side Rendering (Optional)

​Verification

​Troubleshooting

​Next Steps

Quick Start

Configuration

Build docs developers (and LLMs) love

System Requirements

Installation Methods

Development Dependencies

Backend

Frontend

Optional: Docker Setup

Server-Side Rendering (Optional)

Verification

Troubleshooting

Next Steps