sahataba / playrbase

FOSS event & player management solution

Playrbase

Playrbase is a flexible player and event management system.

Requirements

• Tested with NodeJS v20.9.0
• pnpm
• SurrealDB
• minio and mc executable available in PATH
• The dev-s3-create-bucket command is currently broken on windows, so you cannot upload images there at the moment

Get started

• Clone the repo
• Run pnpm i
• Run pnpm dev
• Open http://localhost:13000
• Open devkit from the navbar (top right)
• Run database migrations in the devkit

How to signin/signin (dev)

On the signin page, just enter an email address for which you want to create an account, or for an existing account. Now, to make your life a little bit easier, in development mode Emails are being stored locally so you don't need to configure an API key for some email sending service.

Simply open the Devkit, then go to the Emails tab and find the email there :)

Dev commands

• pnpm dev: Shows NextJS & Devkit logs
• pnpm debug: Shows NextJS, Devkit & SurrealDB logs
• pnpm dbonly: Shows only SurrealDB logs
• pnpm ts: Typescript validation (watch mode)
• pnpm lint: Validate linting (including prettier)
• pnpm lint --fix: Fix linting issues (including prettier)

Ports used

• 13000: NextJS (Frontend)
• 13001: SurrealDB
• 13002: MinIO S3 bucket (Image uploads)
• 13003: MinIO Console address
• 13004: Devkit API
• 13005: React-email devserver

Deploying

Might write a guide later but there are quite some steps, not relevant at this stage.

Contributing

We are rushing at the moment, so I cannot guarantee that your contribution aligns with our strategy/plans/ideas. Please contact us via Discord if you have specific ideas/fixes/features in mind that you would like to work on. We don't have the capability to delagate work however at this time.