Categorygithub.com/hylarucoder/rocketbase
modulepackage
0.0.0-20241030152356-8c950ad76724
Repository: https://github.com/hylarucoder/rocketbase.git
Documentation: pkg.go.dev

# README

Rocketbase

Rocketbase = Pocketbase + PostgreSQL + a lot of goodies

Setup

psql
CREATE
USER your_user WITH PASSWORD 'your_pass';
CREATE
DATABASE rocketbase;
CREATE
DATABASE rocketbase_logs;
GRANT ALL PRIVILEGES ON DATABASE
rocketbase TO your_user;
GRANT ALL PRIVILEGES ON DATABASE
rocketbase_logs TO your_user;
-- test
CREATE
DATABASE test_rocketbase;
CREATE
DATABASE test_rocketbase_logs;
GRANT ALL PRIVILEGES ON DATABASE
test_rocketbase TO your_user;
GRANT ALL PRIVILEGES ON DATABASE
test_rocketbase_logs TO your_user;

CREATE
DATABASE test_rocketbase_basic;
CREATE
DATABASE test_rocketbase_logs_basic;
GRANT ALL PRIVILEGES ON DATABASE
test_rocketbase_basic TO your_user;
GRANT ALL PRIVILEGES ON DATABASE
test_rocketbase_logs_basic TO your_user;

Credit

  • pocketbase for main codebase
  • postgresbase for adapting postgres

# Packages

Package apis implements the default PocketBase api services and middlewares.
No description provided by the author
Package core is the backbone of PocketBase.
Package daos handles common PocketBase DB model manipulations.
No description provided by the author
Package models implements various services used for request data validation and applying changes to existing DB models through the app Dao.
Package mails implements various helper methods for sending user and admin emails like forgotten password, verification, etc.
Package migrations contains the system PocketBase DB migrations.
Package models implements all PocketBase DB models and DTOs.
No description provided by the author
Package resolvers contains custom search.FieldResolver implementations.
Package tests provides common helpers and mocks used in PocketBase application tests.
Package tokens implements various user and admin tokens generation methods.
No description provided by the author
Package ui handles the PocketBase Admin frontend embedding.

# Functions

New creates a new PocketBase instance with the default configuration.
NewWithConfig creates a new PocketBase instance with the provided config.

# Variables

Version of PocketBase.

# Structs

Config is the PocketBase initialization config struct.
PocketBase defines a PocketBase app launcher.