Home Guides
Documentation
Guides
Step-by-step guides for setup, configuration and running your yarn community platform.
Beginner 15 min
Quickstart
Fork the repository, install dependencies, start PocketBase and deploy your first yarn instance.
Read guideBeginner 10 min
Configure whitelabel
Set your own server name, colors and domain through environment variables.
Read guideAdvanced 20 min
FiveM integration
Install yarn_sync, generate API tokens and configure webhooks.
Read guideAdmin 25 min
Admin guide
Manage users, create factions, review smart logs and assign permissions.
Read guideAdvanced 15 min
RP web portal
Enable the public web portal with news, jobs, real estate and social features.
Read guideDeveloper Reference
API reference
All API endpoints, webhook payloads, auth tokens and response structure.
Read guide