PocketBase / SvelteKit Starter App

Use this app as a starting point for your own customized PocketBase backend with SvelteKit frontend. This is a high-performance frontend+backend combination since frontend is static and backend is a single compiled Golang binary (JAMstack baby!).

• SvelteKit frontend is fully static, client-side only so that here is no need for NodeJS at runtime. It is generated using adapter-static and ssr is OFF.
• PocketBase provides complete (and fast) backend including:
  • databse (SQLite)
  • CRUD API for database
  • realtime subscriptions for LIVE data (server push to browser)
  • Authentication and Authorization (email + social login/oauth2)
  • file storage (local filesystem or S3)
  • hooks and API endpoints implemented in JavaScript (goja)
• PocketBase can be downloaded as binary. But if you want to extend it with custom Golang code then code is included to compile it locally with extensions such as custom endpoints (e.g. /api/hello) and database event hooks (e.g. executing Go handler functions when a database row is created)
• It is now also possible to extend the backend with JavaScript. See the example main.pb.ts.
• A full live development setup is included
  • Hot Module Reloading (HMR) of your frontend app when you edit Svelte code (including proxying requests to the PocketBase backend via vite)
  • Hot reloading (restarting) of the PocketBase server using modd when you edit Go code
  • Hot reloading (restarting) of the PocketBase server when JS code is changed in ./pb/pb_hooks

To understand the backend, see ./pb/README.md ("pb" == PocketBase) To understand the frontend, see ./sk/README.md ("sk" == SvelteKit)

Read those README files before proceeding.

Setup

Follow these steps CAREFULLY, or else it won't work. Also read the README files referred above before proceeding.

1. If using Docker then copy .env.example to .env and then edit it to match your environment. And then just run docker compose up -d. Without Docker, see below ...
2. Setup the backend in accordance with ./pb/README.md
3. Setup the frontend in accordance with ./sk/README.md

Developing

After you've done the setup in the above two README files, run the backend and the frontend in dev mode (from sk directory).

# start the backend
npm run dev:backend
# and then start the frontend ...
npm run dev

Now visit http://localhost:5173 (sk) or http://localhost:8090 (pb)

Now making changes in the Svelte code (frontend) or Go code (backend) will show results (almost) immediately.

Usage

To use the app as a user / tester ...

• visit the frontend URL (e.g. http://localhost:5173)
• Navigate around. The Home page is not very interesting.
• The hello page shows and example of frontend calling a custom backend API implemented in Go.
• The posts page shows all existing posts. If that page is empty, then you might want to create some posts. You must be logged in to be able to create posts.
• Into the Login form, you can enter an existing username/password, or check the register checkbox to create a new account (it registers the user and log in immediately).

The above are just some sample features. Now go ahead and implement all kinds of new features.

• Create new collections.
• Create new pages that manipulate the above collections.

Building

See the build process details in the README files for backend and frontend.

Configurable Hooks

Please read about the "hooks" system in ./pb/README.md It is a very easy and powerful way to extend your application with minimal configuration and perhaps no code.

Feedback

Please provide feedback by opening an issue or starting a discussion.