byos_laravel/README.md

Laravel Trmnl Server

This is a PoC of a TRMNL server, written in Laravel. Inspired by https://github.com/usetrmnl/byos_sinatra

⚠️ Not meant for production use.️️ ⚠️

Requirements

• PHP >= 8.2
• ext-imagick
• puppeteer see Browsershot docs

Installation

Clone the repository

git clone git@github.com:bnussbau/laravel-trmnl-server.git

Copy environment file

cp .env.example .env
php artisan key:generate

Install dependencies

composer install
npm i

Run migrations

php artisan migrate --seed

Run the server

To make your server accessible in the network, you can run the following command:

php artisan serve  --host=0.0.0.0 --port 4567

Usage

If your environment is local, you can access the server at http://localhost:4567 and login with user / password admin@example.com / admin@example.com

Add your TRMNL Device

http://localhost:4567/devices

• Add new device
• You can grab the TRMNL Mac Address and API Key from the TRMNL Dashboard. Or debug the incoming request to /api/setup to determine.

Flash Firmware to point Device to your server

See this YouTube guide: https://www.youtube.com/watch?v=3xehPW-PCOM

Generate Screen

• Edit resources/views/trmnl.blade.php
• To generate the screen, run

php artisan trmnl:screen:generate

License

MIT