2 |
3 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/+layout.ejs:
--------------------------------------------------------------------------------
1 |
4 |
5 |
15 | <%- slots.body || slot %>
16 |
17 |
18 |
19 |
23 |
24 |
2 |
3 |
25 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/_private/overview.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Overview
3 | description: PocketPages is a powerful Multi Page Application (MPA) preprocessor for PocketBase with a pluggable architecture.
4 | ---
5 |
6 | # Overview
7 |
8 | PocketPages is a 23KB pluggable Multi-Page Application (MPA) preprocessor for PocketBase. It ships with an EJS template engine and uses a flexible plugin system that lets you efficiently choose additional features (including other templating engines) for your application while maintaining maximum performance.
9 |
10 | Use PocketPages to create slim and modern web apps:
11 |
12 | - Start small and iterate
13 | - SEO-first principals
14 | - No build step
15 | - Fast server-side rendering
16 |
17 | ## Hello world in just one file
18 |
19 | ```ejs
20 | // index.ejs
21 | <%%= `Hello, world!` %>
22 | ```
23 |
24 | <%- include(`browser.ejs`, { content: `Hello, world!`}) %>
25 |
26 | With PocketPages, building apps is easy again. Inside `<%%` and `%>`, you can leverage the full power of ES6 JavaScript inside PocketBase's [JSVM](https://pocketbase.io/jsvm/index.html), which exposes all of PocketBase's built-in functions.
27 |
28 | ## Retro file-based routing
29 |
30 | PocketPages borrows inspiration from SvelteKit's [file-based routing](https://kit.svelte.dev/docs/routing) architecture, so you can do this:
31 |
32 | ```ejs
33 | // +layout.ejs
34 |
35 |
36 | <%%- slot>
37 |
38 |
39 | ```
40 |
41 | <%- include(`browser.ejs`, { bodyTags: `style="background-color: #b5dcb5"`, content: `Hello, world!`}) %>
42 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/_private/toc.md:
--------------------------------------------------------------------------------
1 | # Introduction
2 |
3 | - [Overview of PocketPages](/docs/overview)
4 |
5 | # Getting Started
6 |
7 | - [Installation](/docs/installation)
8 | - [Starter Kits](/docs/starter-kits)
9 | - [Upgrading](/docs/upgrading)
10 |
11 | # User Guide
12 |
13 | - Basics
14 |
15 | - [Creating a Page](/docs/creating-a-page)
16 | - [Directory Structure](/docs/directory-structure)
17 | - [Routing](/docs/routing)
18 | - [Accessing Parameters](/docs/parameters)
19 | - [Loading Data](/docs/loading-data)
20 | - [JSON](/docs/json)
21 |
22 | - Templating
23 |
24 | - [Partials](/docs/partials)
25 | - [Layouts](/docs/layouts)
26 |
27 | - Security and Content
28 |
29 | - [Private files](/docs/private-files)
30 | - [Middleware](/docs/middleware)
31 | - [Asset Management](/docs/asset-management)
32 | - [Static content](/docs/static-content)
33 | - [Managing Secrets](/docs/secrets)
34 |
35 | - Configuration
36 |
37 | - [+config.js](/docs/config)
38 | - [Caching](/docs/caching)
39 | - [Debugging](/docs/debugging)
40 | - [Going Live](/docs/deploying)
41 |
42 | - Official Plugins
43 | - [Overview](/docs/plugins)
44 | - [EJS](/docs/plugins/ejs)
45 | - [Markdown](/docs/plugins/markdown)
46 | - [Realtime](/docs/plugins/realtime)
47 | - [Authentication](/docs/plugins/auth)
48 | - [JS SDK](/docs/plugins/js-sdk)
49 | - [Micro Dash](/docs/plugins/micro-dash)
50 | - [Authoring](/docs/plugins/authoring)
51 |
52 | # Reference
53 |
54 | - [Global API](/docs/global-api)
55 |
56 | - [dbg](/docs/global-api/log)
57 | - [info](/docs/global-api/log)
58 | - [warn](/docs/global-api/log)
59 | - [error](/docs/global-api/log)
60 | - [env](/docs/global-api/env)
61 | - [store](/docs/global-api/store)
62 | - [stringify](/docs/global-api/stringify)
63 | - [url](/docs/global-api/url)
64 |
65 | - [Context API](/docs/context-api)
66 | - [auth](/docs/context-api/auth)
67 | - [api](/docs/context-api/api)
68 | - [asset](/docs/context-api/asset)
69 | - [body](/docs/context-api/body)
70 | - [data](/docs/context-api/data)
71 | - [echo](/docs/context-api/echo)
72 | - [formData](/docs/context-api/form-data)
73 | - [meta](/docs/context-api/meta)
74 | - [params](/docs/context-api/params)
75 | - [redirect/flash](/docs/context-api/redirect)
76 | - [request](/docs/context-api/request)
77 | - [resolve](/docs/context-api/resolve)
78 | - [response](/docs/context-api/response)
79 | - [JSVM](/docs/jsvm)
80 | - [Plugin Authoring](/docs/plugins/authoring)
81 |
82 | # Guides
83 |
84 | - [📒 HTMX Integration](/docs/htmx)
85 | - [📒 Custom Domains on Fly+Cloudflare](/docs/speedruns/custom-domain-fly-cloudflare)
86 | - [📒 Custom Domains on pockethost.io](/docs/speedruns/custom-domain-pockethost)
87 | - [📒 Google OAuth2](/docs/speedruns/google-oauth2)
88 | - [📒 One-Time Passwords](/docs/speedruns/otp)
89 | - [📒 Outgoing Email with Amazon SES](/docs/speedruns/ses)
90 | - [📒 Setting up a new email domain in Google Suite](/docs/speedruns/gs-gmail)
91 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/asset-management.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Asset Management
3 | description: PocketPages handles static assets with automatic fingerprinting and cache invalidation.
4 | ---
5 |
6 | # Asset Management
7 |
8 | PocketPages provides built-in asset management with content-based fingerprinting for efficient cache invalidation.
9 |
10 | ## Directory Structure
11 |
12 | Place your static assets (images, CSS, JS, etc.) alongside the pages that use them:
13 |
14 | ```
15 | pb_hooks/
16 | pages/
17 | feature/
18 | index.md # Your content
19 | styles.css # Feature-specific styles
20 | header.jpg # Feature-specific image
21 | shared/
22 | logo.png # Shared across pages
23 | ```
24 |
25 | ## Using Assets
26 |
27 | ### In Markdown
28 |
29 | Use standard markdown syntax for images - paths are automatically resolved relative to the current file:
30 |
31 | ```markdown
32 |  # Local image
33 |  # Absolute path
34 | ```
35 |
36 | ### In EJS Templates
37 |
38 | Use the `asset()` helper to generate fingerprinted URLs:
39 |
40 | ```ejs
41 |
4 |
10 | <%- slots.body || slot %>
11 |
12 |
13 |
14 |
15 |
20 |
23 |
24 |  %>)
42 |
43 | ```
44 |
45 | ## How It Works
46 |
47 | 1. During startup, PocketPages generates content-based fingerprints for all static files
48 | 2. The `asset()` helper and markdown images automatically generate fingerprinted URLs
49 | 3. URLs are served with long-term cache headers for optimal performance
50 |
51 | ## Best Practices
52 |
53 | 1. Keep assets close to the pages that use them
54 | 2. Use a shared directory (like `shared/` or `assets/`) for common resources
55 | 3. Always verify assets exist in your pages directory
56 |
57 | For detailed information about the `asset()` helper and its features, see the [asset helper documentation](/docs/request-context/asset).
58 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/context-api/api.md:
--------------------------------------------------------------------------------
1 | # `api` - The PocketPages API Object
2 |
3 | - **Type**: Object
4 | - **Description**: The `api` property refers to the PocketPages API object itself. This object contains all the methods and properties needed for page rendering and is spread into the global context of each EJS page, making all its methods available as globals. This can be useful if you need to pass the entire API object downstream, for example, when making further processing decisions or passing it to other modules.
5 |
6 | ## Example Usage:
7 |
8 | ```ejs
9 | <%%
10 | function processApi(api) {
11 | // Access API methods directly
12 | api.print('Hello World');
13 | api.redirect('/some/path');
14 |
15 | // Or use them as globals (since they're spread into the context)
16 | print('Hello World');
17 | redirect('/some/path');
18 | }
19 |
20 | // Pass the entire API object
21 | processApi(api);
22 | %>
23 | ```
24 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/context-api/body.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: body - Raw Request Body
3 | description: Access the raw request body data in PocketPages templates through a function call.
4 | ---
5 |
6 | # `body` - Parsed Request Body
7 |
8 | - **Type**: `() => Record
19 | Received JSON data:
20 |
22 | <%% } %>
23 | <%% } %>
24 | ```
25 |
26 | ### API Endpoint Example
27 |
28 | ```ejs
29 | <%%
30 | if (request.method === 'POST') {
31 | const data = body()
32 | if (typeof data !== 'object' || !data.username || !data.password) {
33 | response.status(400)
34 | response.json({
35 | error: 'Missing required fields'
36 | })
37 | return
38 | }
39 |
40 | try {
41 | const user = signInUserWithPassword(data.username, data.password)
42 | response.json({
43 | success: true,
44 | user: user
45 | })
46 | } catch (error) {
47 | response.status(401)
48 | response.json({
49 | error: error.message
50 | })
51 | }
52 | }
53 | %>
54 | ```
55 |
56 | ## Raw Body Processing
57 |
58 | ```ejs
59 | <%%
60 | if (request.method === 'POST') {
61 | const rawBody = body()
62 |
63 | if (typeof rawBody === 'string') {
64 | // Process raw string data
65 | const lines = rawBody.split('\n')
66 | // ... process the data
67 | response.json({
68 | linesProcessed: lines.length
69 | })
70 | } else {
71 | response.status(400)
72 | response.json({ error: 'Expected raw text data' })
73 | }
74 | }
75 | %>
76 | ```
77 |
78 | ## Important Notes
79 |
80 | 1. `body()` is a function that must be called to access the request body
81 | 2. Returns a JavaScript object for JSON content types
82 | 3. Returns a string for other content types
83 | 4. Consider type checking the return value before using it
84 |
85 | See [Request Handling](/docs/request-handling) for more detailed information about working with HTTP requests in PocketPages.
86 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/context-api/echo.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: echo - Response Output Helper
3 | description: Write directly to the response output, useful for both debugging and custom response handling.
4 | ---
5 |
6 | # `echo()` - Response Output Helper
7 |
8 | - **Type**: `Function(...args: any[]) => void`
9 | - **Description**: Writes values directly to the response output stream
10 | - **Global**: Yes (available as `echo()` in templates)
11 | - **API Method**: `api.echo(...args)`
12 |
13 | > **Note**: `echo()` writes immediately to the response output stream when called, whether in a loader or template. Objects are automatically stringified, so there's no need to call `JSON.stringify()` unless you need special formatting.
14 |
15 | ## Basic Usage
16 |
17 | ```ejs
18 |
19 | <%% echo(someVariable) %>
20 |
21 |
22 | <%% echo({ hello: 'world' }) %>
23 |
24 |
25 | <%% echo('Status:', status, 'Count:', count) %>
26 | ```
27 |
28 | ## Common Use Cases
29 |
30 | ### Debugging
31 |
32 | ```ejs
33 |
34 | <%%= stringify(body()) %>21 |
35 | <%% echo('Data: ', data) %>
36 | <%% echo('Params: ', params) %>
37 | <%% echo('Form: ', formData) %>
38 |
39 |
40 |
41 | <%% echo('>>> Checkpoint 1') %>
42 | ```
43 |
44 | ### Custom Responses
45 |
46 | ```javascript
47 | /** @type {import('pocketpages').MiddlewareLoaderFunc} */
48 | module.exports = function (api) {
49 | const { echo, request } = api
50 |
51 | // Early response - outputs before headers are sent
52 | if (request.header('Accept') === 'application/json') {
53 | echo({ ok: true })
54 | return {}
55 | }
56 |
57 | // Continue to template rendering
58 | return {
59 | /* ... */
60 | }
61 | }
62 | ```
63 |
64 | ### Function Inspection
65 |
66 | ```ejs
67 |
68 | 69 | <%% echo(mysteriousFunction) %> 70 |71 | ``` 72 | 73 | ## echo() vs Logging 74 | 75 | - **echo()**: Immediate response output 76 | 77 | ```ejs 78 | <%% echo(data) %> 79 | ``` 80 | 81 | - **dbg(), info()**: Server-side logging 82 | ```ejs 83 | <%% dbg(data) %> 84 | ``` 85 | 86 | ## Important Notes 87 | 88 | - In loaders, `echo()` writes to the response stream before headers are sent 89 | - In templates, `echo()` writes inline with the template output 90 | - No need to use `<%%= %>` - just `<%% echo() %>` is sufficient 91 | - Multiple arguments are automatically space-separated 92 | - Objects are automatically stringified 93 | 94 | ## See Also 95 | 96 | - [Logging Functions](/docs/global-api/log) 97 | - [Global API](/docs/global-api) 98 | - [Context API Documentation](/docs/context-api) 99 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/context-api/meta.md: -------------------------------------------------------------------------------- 1 | # `meta` - Managing Page Metadata and Global Values 2 | 3 | - **Type**: Function 4 | - **Description**: The `meta` function provides a way to get and set metadata and other global values during request processing. While it can be used for any global values, it's most commonly used to manage page metadata like titles, descriptions, and OpenGraph tags. 5 | 6 | ## Function Signature: 7 | 8 | ```typescript 9 | meta(key: string): string | undefined 10 | meta(key: string, value: string): string 11 | ``` 12 | 13 | ## Usage Patterns: 14 | 15 | 1. **Getting a value**: 16 | 17 | ```ejs 18 | <%% const pageTitle = meta('title'); %> 19 | ``` 20 | 21 | 2. **Setting a value**: 22 | 23 | ```ejs 24 | <%% meta('title', 'Welcome to My Site'); %> 25 | ``` 26 | 27 | ## Common Use Cases: 28 | 29 | The most common use case for `meta` is setting page metadata in your `+load.js` files and then using those values in your layout templates. Here's a typical example from a layout file: 30 | 31 | ```ejs 32 | 33 |
Category: <%%= params.category %>
34 |Product ID: <%%= params.id %>
35 | ``` 36 | 37 | ### Complete Example: Product Details Page 38 | 39 | ```ejs 40 | <%% 41 | // products/[category]/[id].ejs 42 | const { category, id } = params 43 | 44 | // Use parameters for database query 45 | const product = await db.collection('products') 46 | .getOne(id) 47 | 48 | if (!product || product.category !== category) { 49 | response.html(404, `Product Not Found
`) 50 | return 51 | } 52 | %> 53 | 54 | 55 | 56 | 57 |<%%= product.name %>
66 |Category: <%%= category %>
67 |Product ID: <%%= id %>
68 |Price: $<%%= product.price %>
69 |Description: <%%= product.description %>
70 |
74 |
77 |
78 |
79 | ```
80 |
81 | ## Important Notes
82 |
83 | 1. `params` only contains route parameters (from square brackets in paths)
84 | 2. Query string parameters are not directly supported - you'll need to parse them manually from `request.url`
85 | 3. All parameter values are strings
86 | 4. Route parameters are required - if a route parameter is missing, the page won't match
87 |
88 | For query string parameters, you can parse them manually from the request URL:
89 |
90 | ```ejs
91 | <%%
92 | // URL: /products/electronics/123?sort=price&order=desc
93 | const url = new URL(request.url)
94 | const sort = url.searchParams.get('sort')
95 | const order = url.searchParams.get('order')
96 | %>
97 | ```
98 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/context-api/request-oauth2-login.md:
--------------------------------------------------------------------------------
1 | # requestOAuth2Login
2 |
3 | Initiates the OAuth2 authentication flow by redirecting to the provider's authorization endpoint.
4 |
5 | ## Usage
6 |
7 | ```javascript
8 | const authUrl = requestOAuth2Login(providerName)
9 | ```
10 |
11 | ## Parameters
12 |
13 | - `providerName` (string) - The name of the OAuth2 provider (e.g. "google", "github")
14 | - `options` (object, optional)
15 | - `collection` (string) - The collection to authenticate against (defaults to "users")
16 | - `redirectPath` (string) - The path to redirect to after authentication (defaults to "/auth/oauth/confirm")
17 | - `cookieName` (string) - The name of the cookie to store OAuth2 state (defaults to "pp_oauth_state")
18 | - `autoRedirect` (boolean) - Whether to automatically redirect to the provider (defaults to true)
19 |
20 | ## Returns
21 |
22 | Returns the authorization URL if `autoRedirect` is false. Otherwise redirects to the provider's authorization endpoint.
23 |
24 | ## Example
25 |
26 | ```javascript
27 |
37 |
38 |
42 | ```
43 |
44 | ## Notes
45 |
46 | - The function automatically generates and stores a state parameter to prevent CSRF attacks
47 | - The state and other OAuth2 parameters are stored in a cookie for validation during callback
48 | - The default redirect URL is constructed using your app's base URL + the redirectPath option
49 | - Make sure the redirect URL matches what is configured in your OAuth2 provider settings
50 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/context-api/sign-in-with-oauth2.md:
--------------------------------------------------------------------------------
1 | # signInWithOAuth2
2 |
3 | Completes the OAuth2 authentication flow by exchanging the authorization code for an access token and user data.
4 |
5 | ## Usage
6 |
7 | ```javascript
8 | const authData = signInWithOAuth2(state, code)
9 | ```
10 |
11 | ## Parameters
12 |
13 | - `state` (string) - The state parameter returned from the OAuth2 provider
14 | - `code` (string) - The authorization code returned from the OAuth2 provider
15 | - `options` (object, optional) - Additional options
16 | - `collection` (string) - The collection to authenticate against (defaults to "users")
17 | - `cookieName` (string) - The name of the cookie storing the OAuth2 state (defaults to "pp_oauth_state")
18 |
19 | ## Returns
20 |
21 | Returns an object containing:
22 |
23 | - `token` - The authentication token
24 | - `record` - The user record
25 |
26 | ## Example
27 |
28 | ```javascript
29 |
39 | ```
40 |
41 | ## Notes
42 |
43 | - This function is typically called on your OAuth2 callback route after the provider redirects back to your application
44 | - The function automatically validates the state parameter against the stored state to prevent CSRF attacks
45 | - On successful authentication, the user is automatically signed in and the auth cookie is set
46 | - Throws an error if the state validation fails or if the OAuth2 flow cannot be completed
47 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/context-api/sign-in-with-token.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: signInWithToken - Token Authentication
3 | description: Set authentication state using a token in PocketPages templates.
4 | ---
5 |
6 | # `signInWithToken` - Token Authentication
7 |
8 | - **Type**: `(token: string) => void`
9 | - **Description**: Core authentication function that sets the `pb_auth` cookie. All other authentication methods (`signInWithPassword`, `registerWithPassword`, `signInAnonymously`) internally use this function to set the cookie.
10 |
11 | ## Basic Usage
12 |
13 | ```ejs
14 | <%%
15 | // Set authentication using a token
16 | signInWithToken('your-auth-token-here')
17 | redirect('/dashboard')
18 | %>
19 | ```
20 |
21 | ## Cookie Management
22 |
23 | This is the only function that directly sets the `pb_auth` cookie. Other authentication methods work like this:
24 |
25 | ```typescript
26 | // How signInWithPassword works internally
27 | function signInWithPassword(email: string, password: string) {
28 | // 1. Authenticate with PocketBase
29 | const authData = pb.collection('users').authWithPassword(...)
30 |
31 | // 2. Use signInWithToken to set the cookie
32 | signInWithToken(authData.token)
33 |
34 | return authData
35 | }
36 | ```
37 |
38 | ## Common Use Cases
39 |
40 | ### OAuth Flow Completion
41 |
42 | ```ejs
43 | <%%
44 | // After receiving token from OAuth provider
45 | const token = params.token
46 | if (token) {
47 | signInWithToken(token)
48 | redirect('/dashboard')
49 | } else {
50 | redirect('/login?error=missing_token')
51 | }
52 | %>
53 | ```
54 |
55 | ### Custom Authentication Flow
56 |
57 | ```ejs
58 | <%%
59 | if (request.method === 'POST') {
60 | try {
61 | // Custom authentication logic
62 | const response = await customAuthProvider.authenticate(formData)
63 |
64 | if (response.token) {
65 | signInWithToken(response.token)
66 | redirect('/dashboard')
67 | }
68 |
69 | } catch (error) {
70 | %>
71 | Route Parameters
75 |<%%= stringify(params) %>76 |
72 | Authentication failed: <%%= error.message %>
73 |
74 | <%%
75 | }
76 | }
77 | %>
78 | ```
79 |
80 | ## Important Notes
81 |
82 | 1. **Cookie Management**: This function:
83 |
84 | - Is the core cookie-setting function used by all auth methods
85 | - Sets the `pb_auth` cookie with the provided token
86 | - Does not validate the token
87 | - Does not fetch the user record
88 |
89 | 2. **Security Considerations**:
90 |
91 | - Always validate tokens before using them
92 | - Use HTTPS in production
93 | - Consider token expiration
94 | - Protect against CSRF attacks
95 |
96 | 3. **Usage Context**: Typically used:
97 | - After third-party authentication
98 | - In custom authentication flows
99 | - When implementing token refresh logic
100 | - Internally by other auth methods
101 |
102 | ## Related Topics
103 |
104 | - [`signInWithPassword`](/docs/context-api/sign-in-with-password)
105 | - [`signOut`](/docs/context-api/sign-out)
106 | - [`request.auth`](/docs/context-api/auth)
107 | - [Authentication Guide](/docs/authentication)
108 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/context-api/sign-out.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: signOut - User Logout
3 | description: Sign out the current user by clearing their authentication cookie in PocketPages templates.
4 | ---
5 |
6 | # `signOut` - User Logout
7 |
8 | - **Type**: `() => void`
9 | - **Description**: Signs out the current user by clearing their authentication cookie. After calling this function, `request.auth` will be `undefined` on subsequent requests.
10 |
11 | ## Basic Usage
12 |
13 | ```ejs
14 | <%%
15 | signOut()
16 | redirect('/login')
17 | %>
18 | ```
19 |
20 | ## Common Use Cases
21 |
22 | ### Logout Button/Form
23 |
24 | ```ejs
25 | <%%
26 | if (request.method === 'POST' && formData.action === 'logout') {
27 | signOut()
28 | redirect('/login')
29 | }
30 | %>
31 |
32 |
36 | ```
37 |
38 | ### Session Expiry Handler
39 |
40 | ```ejs
41 | <%%
42 | if (request.auth) {
43 | const lastActivity = new Date(request.auth.get('lastActivity'))
44 | const now = new Date()
45 | const inactiveTime = now - lastActivity
46 |
47 | if (inactiveTime > 30 * 60 * 1000) { // 30 minutes
48 | signOut()
49 | redirect('/login?reason=session_expired')
50 | return
51 | }
52 | }
53 | %>
54 | ```
55 |
56 | ## Important Notes
57 |
58 | 1. **Cookie Management**: This function:
59 |
60 | - Clears the authentication cookie
61 | - Takes effect immediately
62 | - Does not require a server response
63 |
64 | 2. **Security Considerations**:
65 |
66 | - Always redirect after logout
67 | - Clear any client-side state
68 | - Consider implementing CSRF protection
69 | - Use POST requests for logout actions
70 |
71 | 3. **Best Practices**:
72 |
73 | - Redirect to login page after logout
74 | - Show confirmation messages
75 | - Handle errors gracefully
76 | - Consider cleanup of user-specific data
77 |
78 | 4. **Client-Side Integration**:
79 | - This function only clears the server-side cookie
80 | - If using the PocketBase JS SDK on the frontend, you'll need to handle its authentication state separately
81 | - The SDK uses localStorage for JWT storage, which isn't affected by cookie changes
82 | - Consider implementing a complete logout that handles both:
83 |
84 | ```ejs
85 |
86 |
99 |
100 |
101 | ```
102 |
103 | ## Related Topics
104 |
105 | - [`signInWithPassword`](/docs/context-api/sign-in-with-password)
106 | - [`signInWithToken`](/docs/context-api/sign-in-with-token)
107 | - [`request.auth`](/docs/context-api/auth)
108 | - [Authentication Guide](/docs/authentication)
109 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/creating-a-page.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Creating a PocketPages Page
3 | description: Step-by-step process for creating and organizing EJS template files in PocketPages, including file naming conventions, directory structure, and URL routing patterns.
4 | ---
5 |
6 | # Creating a PocketPages Page
7 |
8 | PocketPages allows you to create dynamic pages for your application using EJS templating. Below are the steps and guidelines to create a page that will be served by PocketPages.
9 |
10 | ## Creating Pages
11 |
12 | 1. **Create an EJS File**: Inside the `pb_hooks/pages/` directory, create an `.ejs` file. This file will represent the page that you want to serve.
13 |
14 | For example, to create an "About" page:
15 |
16 | ```text
17 | pb_hooks/pages/about.ejs
18 | ```
19 |
20 | 2. **Special Case - `index.ejs`**: The `index.ejs` file has a special role at any directory level.
21 |
22 | At the root level:
23 |
24 | ```text
25 | pb_hooks/pages/index.ejs -> serves "/"
26 | ```
27 |
28 | In subdirectories:
29 |
30 | ```text
31 | pb_hooks/pages/products/index.ejs -> serves "/products"
32 | ```
33 |
34 | 3. **Serving Pages**: Any `.ejs` file within `pb_hooks/pages/` can be served directly. The name of the file (minus the `.ejs` extension) will correspond to the URL path.
35 |
36 | Example file structure:
37 |
38 | ```text
39 | pb_hooks/pages/
40 | ├── index.ejs -> "/"
41 | ├── about.ejs -> "/about"
42 | ├── contact.ejs -> "/contact"
43 | └── products/
44 | ├── index.ejs -> "/products"
45 | └── details.ejs -> "/products/details"
46 | ```
47 |
48 | 4. **Nested Pages**: You can organize your pages into subdirectories. The routing will follow the directory structure. If no specific file matches the route, an `index.ejs` in the corresponding directory will be served.
49 |
50 | Example routing table:
51 |
52 | ```text
53 | URL Path File Path
54 | / pb_hooks/pages/index.ejs
55 | /about pb_hooks/pages/about.ejs
56 | /contact pb_hooks/pages/contact.ejs
57 | /products pb_hooks/pages/products/index.ejs
58 | /products/details pb_hooks/pages/products/details.ejs
59 | ```
60 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/database.md:
--------------------------------------------------------------------------------
1 | # Server-side Data
2 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/debugging.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Debugging in PocketPages
3 | description: Learn how to enable and configure debugging output in PocketPages applications.
4 | ---
5 |
6 | # Debugging in PocketPages
7 |
8 | PocketPages provides several levels of debugging output to help you develop and troubleshoot your application.
9 |
10 | ## Development Mode
11 |
12 | Running PocketBase with the `--dev` flag automatically enables debug output from the `dbg()` function (see [Logging Functions](/docs/global-api/log) for details):
13 |
14 | ```bash
15 | pocketbase serve --dev
16 | ```
17 |
18 | Without the `--dev` flag, all `dbg()` output is suppressed, making your production logs cleaner and more focused on important information.
19 |
20 | ## Plugin Debugging
21 |
22 | Each plugin can have its own debug output enabled or disabled. By default, plugin debugging is disabled. You can enable it for specific plugins in your `+config.js` file:
23 |
24 | ```javascript
25 | module.exports = {
26 | plugins: [
27 | // Enable debugging for just the EJS plugin
28 | {
29 | name: 'pocketpages-plugin-ejs',
30 | debug: true,
31 | },
32 |
33 | // Other plugins remain quiet
34 | 'pocketpages-plugin-marked',
35 | ],
36 | debug: false,
37 | }
38 | ```
39 |
40 | See [Configuration](/docs/config) for more details about plugin configuration.
41 |
42 | ## Core Debugging
43 |
44 | PocketPages core debugging is disabled by default. While rarely needed, you can enable it by setting the top-level `debug` option in your `+config.js`:
45 |
46 | ```javascript
47 | module.exports = {
48 | plugins: ['pocketpages-plugin-ejs'],
49 | debug: true, // Enable core debugging
50 | }
51 | ```
52 |
53 | This will output detailed information about routes, parameters, and other internal details that can be helpful when troubleshooting core PocketPages behavior.
54 |
55 | > **Note**: Enabling core debugging can produce a lot of output. It's recommended to only enable it when specifically debugging PocketPages core functionality.
56 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/(main)/docs/deploying.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Deploying to Production
3 | description: Deploy PocketPages to pockethost.io with manual or GitHub Actions workflows, or self-host on Fly.io. Includes deployment scripts, environment setup, and configuration steps.
4 | ---
5 |
6 | # Deploying to Production
7 |
8 | PocketPages is easy to deploy. If you follow the [recommended project structure](/docs/structure), everything in `/pb_*` can be deployed.
9 |
10 | The two most popular ways to go live with PocketBase are to use [pockethost.io](https://pockethost.io) or to self-host using [Fly.io](https://fly.io).
11 |
12 | ## Recommended: Deploy to pockethost.io
13 |
14 | pockethost.io is the premiere PocketBase hosting service trusted by over 10,000 developers and millions of end users.
15 |
16 | In under 30 seconds, you can provision a free instance with unlimited (Fair Use) resources.
17 |
18 | ### Manual Deployment
19 |
20 | The easiest way to deploy is using the PocketHost.IO CLI utility (PHIO). Here's how:
21 |
22 | 1. Install the PHIO CLI globally:
23 |
24 | ```bash
25 | npm i -g phio
26 | ```
27 |
28 | 2. Login to your PocketHost account:
29 |
30 | ```bash
31 | phio login
32 | ```
33 |
34 | 3. Link your local project to your PocketHost instance:
35 |
36 | ```bash
37 | phio link Using API key: <%%= apiKey %>
23 | ``` 24 | 25 | ## Security Notes 26 | 27 | - Returns empty string for undefined variables 28 | - Use for sensitive configuration 29 | - Avoid exposing secrets in templates 30 | - Prefer environment variables over hardcoded values 31 | 32 | ## Best Practices 33 | 34 | 1. **Check for Required Variables** 35 | 36 | ```javascript 37 | const apiKey = env('API_KEY') 38 | if (!apiKey) { 39 | error('Missing required API_KEY environment variable') 40 | // Handle error case 41 | } 42 | ``` 43 | 44 | 2. **Use Descriptive Names** 45 | 46 | ```javascript 47 | // Good 48 | const stripeSecretKey = env('STRIPE_SECRET_KEY') 49 | 50 | // Avoid 51 | const key = env('KEY') 52 | ``` 53 | 54 | 3. **Document Required Variables** 55 | 56 | ```javascript 57 | // Document required environment variables in your README or configuration files 58 | /** 59 | * Required environment variables: 60 | * - API_KEY: Your API key for external service 61 | * - DB_PASSWORD: Database password 62 | * - SMTP_PASSWORD: Email service password 63 | */ 64 | ``` 65 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/global-api/micro-dash.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Micro-dash Functions 3 | description: Lightweight utility functions for working with arrays and objects 4 | --- 5 | 6 | # Micro-dash Functions 7 | 8 | PocketPages includes a subset of utility functions from [@s-libs/micro-dash](https://github.com/simontonsoftware/s-libs/tree/master/projects/micro-dash) for working with arrays and objects. These functions are available globally in templates and via `require('pocketpages')`. 9 | 10 | ## Available Functions 11 | 12 | ### forEach 13 | 14 | Iterates over elements of a collection and invokes an iteratee for each element. 15 | 16 | ```js 17 | const { forEach } = require('pocketpages') 18 | 19 | forEach([1, 2, 3], (value) => { 20 | dbg(value) 21 | }) 22 | 23 | forEach({ a: 1, b: 2 }, (value, key) => { 24 | dbg(key, value) 25 | }) 26 | ``` 27 | 28 | ### keys 29 | 30 | Gets the object's property names as an array. 31 | 32 | ```js 33 | const { keys } = require('pocketpages') 34 | 35 | const obj = { a: 1, b: 2, c: 3 } 36 | const propertyNames = keys(obj) 37 | // => ['a', 'b', 'c'] 38 | ``` 39 | 40 | ### values 41 | 42 | Gets the object's property values as an array. 43 | 44 | ```js 45 | const { values } = require('pocketpages') 46 | 47 | const obj = { a: 1, b: 2, c: 3 } 48 | const propertyValues = values(obj) 49 | // => [1, 2, 3] 50 | ``` 51 | 52 | ### merge 53 | 54 | Recursively merges own enumerable properties of source objects into the destination object. 55 | 56 | ```js 57 | const { merge } = require('pocketpages') 58 | 59 | const object = { 60 | a: [{ b: 2 }, { d: 4 }], 61 | } 62 | 63 | const other = { 64 | a: [{ c: 3 }, { e: 5 }], 65 | } 66 | 67 | merge(object, other) 68 | // => { a: [{ b: 2, c: 3 }, { d: 4, e: 5 }] } 69 | ``` 70 | 71 | ### pick 72 | 73 | Creates an object composed of the picked object properties. 74 | 75 | ```js 76 | const { pick } = require('pocketpages') 77 | 78 | const object = { a: 1, b: 2, c: 3, d: 4 } 79 | pick(object, ['a', 'c']) 80 | // => { a: 1, c: 3 } 81 | ``` 82 | 83 | ## Using in Templates 84 | 85 | These functions are automatically available in EJS templates: 86 | 87 | ```ejs 88 | <%% 89 | forEach(['Home', 'About', 'Contact'], (page) => { 90 | echo(`${page}`) 91 | }) 92 | %> 93 | 94 | <%% 95 | const config = { theme: 'dark', lang: 'en' } 96 | const userPrefs = { theme: 'light' } 97 | const finalConfig = merge({}, config, userPrefs) 98 | %> 99 | ``` 100 | 101 | ## Using in JavaScript Files 102 | 103 | Import the functions you need from the PocketPages package: 104 | 105 | ```js 106 | const { forEach, keys, values, merge, pick } = require('pocketpages') 107 | 108 | function processObject(obj) { 109 | forEach(keys(obj), (key) => { 110 | dbg(`Processing ${key}:`, obj[key]) 111 | }) 112 | } 113 | ``` 114 | 115 | For more detailed information about these utility functions, refer to the [@s-libs/micro-dash documentation](https://github.com/simontonsoftware/s-libs/tree/master/projects/micro-dash). 116 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/global-api/stringify.md: -------------------------------------------------------------------------------- 1 | # `stringify` - Circular-Safe Stringify Helper 2 | 3 | - **Type**: Function 4 | - **Description**: The `stringify` helper is a `JSON.stringify` replacement that prevents circular references from causing errors. It is useful when you need to serialize complex objects for logging or debugging. 5 | 6 | ## Example Usage: 7 | 8 | ```ejs 9 | <%% log.dbg("Request Context:", stringify(context)); %> 10 | ``` 11 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/global-api/url.md: -------------------------------------------------------------------------------- 1 | # `url` - URL Parsing Function 2 | 3 | - **Type**: Function 4 | - **Description**: The `url` function is used to parse a URL string. It returns an object equivalent to using `new URL()` in the browser's Web API, with the addition of automatic query string parsing into an object. This can be helpful for manipulating or inspecting URLs within your EJS templates. 5 | 6 | ## Example Usage: 7 | 8 | ```ejs 9 | <%% 10 | // Basic URL parsing 11 | const parsedUrl = url('https://example.com/path?query=123'); 12 | %> 13 |Hostname: <%%= parsedUrl.hostname %>
14 |Pathname: <%%= parsedUrl.pathname %>
15 |Search: <%%= parsedUrl.search %>
16 | 17 | <%% 18 | // Query string parsing 19 | const withQuery = url('https://example.com/search?name=john&age=25&tags[]=one&tags[]=two') 20 | 21 | // Query parameters are automatically parsed into an object 22 | dbg({ 23 | name: withQuery.query.name, // "john" 24 | age: withQuery.query.age, // "25" 25 | tags: withQuery.query.tags // ["one", "two"] 26 | }) 27 | %> 28 | ``` 29 | 30 | ## Query String Parsing 31 | 32 | The `query` property contains an object with all query parameters parsed: 33 | 34 | - Simple parameters become string values 35 | - Array parameters (using `[]`) become arrays 36 | - Empty values become empty strings 37 | - Missing values become `undefined` 38 | 39 | ```ejs 40 | <%% 41 | const examples = [ 42 | url('/?name=alice'), // query.name === "alice" 43 | url('/?items[]=1&items[]=2'), // query.items === ["1", "2"] 44 | url('/?empty='), // query.empty === "" 45 | url('/?missing'), // query.missing === undefined 46 | url('/?a=1&b=2&c=3') // query === { a: "1", b: "2", c: "3" } 47 | ] 48 | %> 49 | ``` 50 | 51 | ## See Also 52 | 53 | - [Request Context](/docs/context-api/request) 54 | - [Redirect](/docs/context-api/redirect) 55 | - [Parameters](/docs/parameters) 56 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/index.md: -------------------------------------------------------------------------------- 1 | <%- include('overview.md') %> 2 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/installation.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Installation 3 | description: Step-by-step guide for installing PocketPages. 4 | --- 5 | 6 | # Installation 7 | 8 | > **PocketPages requires PocketBase v0.25.5 or later.** 9 | 10 | Installing PocketPages is easy. 11 | 12 | <%- include(`quickstart.ejs`) %> 13 | 14 | _Note: `--dir=pb_data` is necessary to tell PocketBase to use the current directory for data storage._ 15 | 16 | Browse to `http://localhost:8090` and with any luck at all, you'll see: 17 | 18 | <%- include(`browser.ejs`, { url: `http://localhost:8090`, content: `Hello, world!`}) %> 19 | 20 | To start editing, find 21 | 22 | ``` 23 | ./pb_hooks/pages/index.ejs 24 | ``` 25 | 26 | Changes appear immediately on the next refresh. 27 | 28 | ## How does it work? 29 | 30 | PocketPages is a Multi-Page Application (MPA) preprocessor for PocketBase. It listens for requests and renders pages using file-based routing rules like old school PHP. 31 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/jsvm.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: JavaScript API 3 | description: PocketBase's JavaScript runtime environment capabilities, limitations, and examples for database operations, with details on NPM package compatibility and available APIs. 4 | --- 5 | 6 | # JavaScript API 7 | 8 | PocketBase's JavaScript runtime environment is neither Browser nor NodeJS. As such, it lacks Web APIs and NodeJS APIs such as `Buffer` and `require('fs')`. 9 | 10 | There is [extensive documentation](https://pocketbase.io/docs/js-overview/) covering many aspects of extending PocketBase with JS hooks. You'll probably be most concerned with [database operations](https://pocketbase.io/docs/js-database/) and higher-level [record operations](https://pocketbase.io/docs/js-records/), like this: 11 | 12 | ```js 13 | const records = $app.findRecordsByExpr( 14 | 'articles', 15 | $dbx.exp('LOWER(username) = {:username}', { username: 'John.Doe' }), 16 | $dbx.hashExp({ status: 'pending' }) 17 | ) 18 | ``` 19 | 20 | Going even deeper, look at the [PocketBase JSVM docs](https://pocketbase.io/jsvm/index.html) to see available APIs. It's a little hard to understand, so hopefully the examples we provide will help to fill in any unfamiliar concepts. 21 | 22 | ## But can I use my favorite NPM package? 23 | 24 | Probably not, but maybe you're luckier than I am. Any NPM modules that work as pure EcmaScript will also work inside PocketBase, as long as they are CommonJS. 25 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/markdown.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Markdown Support 3 | description: PocketPages processes .md files through EJS templating and Markdown parsing, with built-in frontmatter support for metadata extraction via the meta() function in templates. 4 | --- 5 | 6 | # Markdown Support in PocketPages 7 | 8 | PocketPages supports rendering `.md` files, treating them similarly to `.ejs` files but with an additional step: Markdown parsing. 9 | 10 | ## How It Works: 11 | 12 | 1. **EJS Processing**: Any file with the `.md` extension is first processed through the EJS engine, just like a regular `.ejs` file. This means you can use all the dynamic templating features of EJS within your Markdown files. 13 | 14 | 2. **Markdown Parsing**: After EJS processing, the content is passed through a Markdown parser. This ensures that any Markdown syntax (such as headers, lists, and links) is properly rendered into HTML. 15 | 16 | 3. **Final Output**: The last step in the pipeline is Markdown parsing, so the final output is HTML content that reflects both your EJS logic and your Markdown formatting. 17 | 18 | ## Frontmatter Support 19 | 20 | Any frontmatter properties defined at the top of your Markdown file will be automatically available through the request context's `meta` function. For example: 21 | 22 | ```markdown 23 | --- 24 | title: My Blog Post 25 | description: A detailed guide about something interesting 26 | author: John Doe 27 | --- 28 | 29 | # Content starts here... 30 | ``` 31 | 32 | You can then access these values in your layouts or other templates using the `meta` function: 33 | 34 | ```ejs 35 |Product: <%%= params.productId %>
37 | 38 | 39 |Product: <%%= params.productId %>
40 |Review: <%%= params.reviewId %>
41 | ``` 42 | 43 | ## Query Parameters 44 | 45 | Query parameters come from the URL's query string (after the `?`). They're also available through `params`: 46 | 47 | ``` 48 | /products/123?sort=latest&highlight=true 49 | ``` 50 | 51 | Access them the same way in templates: 52 | 53 | ```ejs 54 |Sort by: <%%= params.sort %>
55 |Highlight: <%%= params.highlight %>
56 | ``` 57 | 58 | ## Parameter Priority 59 | 60 | Query parameters override route parameters when they have the same name: 61 | 62 | ``` 63 | /products/123?productId=789 64 | ``` 65 | 66 | Here, `params.productId` will be `789`, not `123`. 67 | 68 | ## Complete Example 69 | 70 | URL: 71 | 72 | ``` 73 | /products/123/reviews/456?sort=latest&highlight=true 74 | ``` 75 | 76 | Template: 77 | 78 | ```ejs 79 |Product: <%%= params.productId %>
80 |Review: <%%= params.reviewId %>
81 |Sort by: <%%= params.sort %>
82 |Highlight: <%%= params.highlight %>
83 | ``` 84 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/plugins/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Plugins 3 | description: Extend PocketPages with custom functionality using its powerful plugin architecture. 4 | --- 5 | 6 | # Plugins 7 | 8 | PocketPages has a highly **flexible plugin architecture** that allows you to extend the framework far beyond templating. Plugins can interact with various stages of your application, from request and response handling to rendering and extending the API context. 9 | 10 | ## Official Plugins 11 | 12 | PocketPages comes with several official plugins: 13 | 14 | - **EJS Plugin**: Template processing with enhanced features 15 | - **Markdown Plugin**: Process Markdown files with frontmatter support 16 | - **Realtime Plugin**: Add Server-Sent Events (SSE) support 17 | - **Authentication Plugin**: Complete auth system with multiple methods 18 | - **JS SDK Plugin**: PocketBase JavaScript SDK integration 19 | - **Micro Dash Plugin**: Lightweight utility functions for data manipulation 20 | 21 | ## What Can Plugins Do? 22 | 23 | - **Extend Request and Response:** 24 | Use hooks such as `onRequest` and `onResponse` to modify request processing and response delivery. 25 | - **Customize Rendering:** 26 | Intercept and modify output with the `onRender` hook. 27 | - **Extend the API:** 28 | Add custom functions or even integrate entire sub-applications via `onExtendContextApi`. 29 | 30 | ## Plugin Processing Order 31 | 32 | Plugins are processed in the order they appear in your `plugins` array. This is particularly important when plugins modify content, as each plugin's output becomes the input for the next plugin. 33 | 34 | For example, when using both EJS and Markdown plugins: 35 | 36 | ```javascript 37 | module.exports = { 38 | plugins: [ 39 | // First: Process EJS templates 40 | 'pocketpages-plugin-ejs', 41 | // Second: Convert Markdown to HTML 42 | 'pocketpages-plugin-marked', 43 | ], 44 | } 45 | ``` 46 | 47 | This sequential processing allows you to: 48 | 49 | - Chain transformations 50 | - Extend functionality incrementally 51 | - Control how content is processed 52 | 53 | Consider the processing order when configuring plugins that work together or modify the same types of content. 54 | -------------------------------------------------------------------------------- /packages/site/pb_hooks/pages/(main)/docs/plugins/micro-dash.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Micro Dash Plugin 3 | description: Lightweight utility functions for data manipulation in PocketPages applications. 4 | --- 5 | 6 | # Micro Dash Plugin 7 | 8 | The Micro Dash plugin (`pocketpages-plugin-micro-dash`) provides a set of lightweight utility functions for data manipulation, based on the `@s-libs/micro-dash` library. 9 | 10 | ## Installation 11 | 12 | ```bash 13 | npm install pocketpages-plugin-micro-dash 14 | ``` 15 | 16 | ## Configuration 17 | 18 | Add the plugin to your `+config.js` file: 19 | 20 | ```javascript 21 | module.exports = { 22 | plugins: [ 23 | 'pocketpages-plugin-micro-dash', 24 | // ... other plugins 25 | ], 26 | } 27 | ``` 28 | 29 | ## Available Functions 30 | 31 | The plugin adds several utility functions to the global context: 32 | 33 | ```typescript 34 | // Collection Operations 35 | function forEach
2 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/+config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | plugins: [
3 | {
4 | name: `pocketpages-plugin-ejs`,
5 | extensions: ['.ejs', '.md'],
6 | debug: true,
7 | },
8 | 'pocketpages-plugin-marked',
9 | ],
10 | }
11 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/_private/browser.ejs:
--------------------------------------------------------------------------------
1 |
3 |
27 |
4 | 
6 |
26 | PocketPages
5 |
6 |
7 | Build faster with Server-Side web pages - no build chain or complicated
8 | tech stack required.
9 |
10 |
11 |
12 |
15 |
16 | <%- include(`browser.ejs`, { content: `Hello, PocketPages!` }) %>
17 |
18 | // pb_hooks/pages/index.ejs
13 | <%%= `Hello, PocketPages!` %>
19 |
25 | Quickstart
20 | <%- include(`quickstart.ejs`) %>
21 |
22 | Read the Docs
23 |
24 |
2 |
7 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/_private/npm.ejs:
--------------------------------------------------------------------------------
1 | >
8 | <%- data.content||`This page is empty.`%>
9 |
10 |
2 |
10 |
52 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/_private/quickstart.ejs:
--------------------------------------------------------------------------------
1 |
11 |
15 |
22 | <%= data.commands.bun %>
23 |
27 |
34 | <%= data.commands.pnpm %>
35 |
39 |
46 | <%= data.commands.yarn %>
47 |
51 | <%= data.commands.npm %>
2 | Step 1: Copy the minimal starter.
3 |
4 |
5 |
6 |
7 |
11 |
12 | npx tiged benallfree/pocketpages/packages/starters/minimal .
8 | cd minimal
9 | npm install
13 | Step 2: Run.
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/_private/version.ejs:
--------------------------------------------------------------------------------
1 | pocketbase --dir=minimal/pb_data --dev serve
18 | 
2 | 
3 | 
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/android-chrome-192x192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/benallfree/pocketpages/273886e5f7c1fa07346bb6927b050fe03d7a4930/packages/site/pb_hooks/pages/android-chrome-192x192.png
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/android-chrome-512x512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/benallfree/pocketpages/273886e5f7c1fa07346bb6927b050fe03d7a4930/packages/site/pb_hooks/pages/android-chrome-512x512.png
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/benallfree/pocketpages/273886e5f7c1fa07346bb6927b050fe03d7a4930/packages/site/pb_hooks/pages/apple-touch-icon.png
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/assets/app.tailwind.css:
--------------------------------------------------------------------------------
1 | @tailwind base;
2 | @tailwind components;
3 | @tailwind utilities;
4 |
5 | @layer components {
6 | .code-toolbar {
7 | @apply max-w-lg;
8 | }
9 |
10 | .toc {
11 | h1 {
12 | @apply text-lg;
13 | }
14 | ul {
15 | @apply pl-0;
16 | @apply list-none;
17 | @apply mt-0;
18 | }
19 | li,
20 | li a {
21 | @apply m-0 p-0;
22 | @apply text-sm;
23 | }
24 | }
25 | pre {
26 | background-color: #282c34 !important;
27 | }
28 |
29 | .mockup-browser {
30 | .mockup-browser-toolbar {
31 | .input {
32 | @apply ml-0 text-left w-full;
33 | }
34 | }
35 | }
36 | }
37 |
38 | @media (pointer: coarse) {
39 | /* Styles for touch devices */
40 | div.code-toolbar > .toolbar {
41 | opacity: initial;
42 | }
43 | }
44 |
45 | @media (pointer: fine) {
46 | /* Styles for non-touch devices */
47 | }
48 |
49 | div.code-toolbar {
50 | @apply w-full;
51 | }
52 | div.code-toolbar > .toolbar > .toolbar-item > a,
53 | div.code-toolbar > .toolbar > .toolbar-item > button,
54 | div.code-toolbar > .toolbar > .toolbar-item > span {
55 | @apply text-neutral-content bg-neutral-700 lowercase p-0.5 pb-1;
56 | }
57 |
58 | div.code-toolbar > .toolbar > .toolbar-item > a:hover,
59 | div.code-toolbar > .toolbar > .toolbar-item > a:focus,
60 | div.code-toolbar > .toolbar > .toolbar-item > button:hover,
61 | div.code-toolbar > .toolbar > .toolbar-item > button:focus,
62 | div.code-toolbar > .toolbar > .toolbar-item > span:hover,
63 | div.code-toolbar > .toolbar > .toolbar-item > span:focus {
64 | @apply bg-neutral-600 text-neutral-content;
65 | }
66 |
67 | div.code-toolbar > .toolbar > .toolbar-item > a[data-copy-state='copy-success'],
68 | div.code-toolbar
69 | > .toolbar
70 | > .toolbar-item
71 | > button[data-copy-state='copy-success'],
72 | div.code-toolbar
73 | > .toolbar
74 | > .toolbar-item
75 | > span[data-copy-state='copy-success'] {
76 | @apply text-success;
77 | }
78 |
79 | blockquote p:first-of-type::before {
80 | content: '';
81 | }
82 | blockquote p:last-of-type::after {
83 | content: '';
84 | }
85 |
86 | .prose.toc > ul > li > p {
87 | @apply p-0 m-0;
88 | }
89 |
90 | .prose.toc :where(li ul) {
91 | @apply ms-1;
92 | }
93 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/benallfree/pocketpages/273886e5f7c1fa07346bb6927b050fe03d7a4930/packages/site/pb_hooks/pages/favicon-16x16.png
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/benallfree/pocketpages/273886e5f7c1fa07346bb6927b050fe03d7a4930/packages/site/pb_hooks/pages/favicon-32x32.png
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/benallfree/pocketpages/273886e5f7c1fa07346bb6927b050fe03d7a4930/packages/site/pb_hooks/pages/favicon.ico
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/otp.pb.js:
--------------------------------------------------------------------------------
1 | require(`pocketbase-otp`)
2 |
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pages/site.webmanifest:
--------------------------------------------------------------------------------
1 | {"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}
--------------------------------------------------------------------------------
/packages/site/pb_hooks/pocketpages.pb.js:
--------------------------------------------------------------------------------
1 | require('pocketpages')
2 |
--------------------------------------------------------------------------------
/packages/site/postcss.config.js:
--------------------------------------------------------------------------------
1 | // postcss.config.js
2 | module.exports = {
3 | plugins: {
4 | 'postcss-import': {},
5 | tailwindcss: {},
6 | autoprefixer: {},
7 | },
8 | }
9 |
--------------------------------------------------------------------------------
/packages/site/tailwind.config.js:
--------------------------------------------------------------------------------
1 | /** @type {import('tailwindcss').Config} */
2 | export default {
3 | content: ['./pb_hooks/pages/**/*.{ejs,md}'],
4 | theme: {
5 | extend: {},
6 | },
7 | daisyui: {
8 | themes: ['cupcake'],
9 | },
10 | plugins: [require('@tailwindcss/typography'), require('daisyui')],
11 | }
12 |
--------------------------------------------------------------------------------
/packages/starters/.gitignore:
--------------------------------------------------------------------------------
1 | pb_data
2 | !pb_hooks
3 | bun.lockb
4 | node_modules
--------------------------------------------------------------------------------
/packages/starters/auth/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # pocketpages-starter-auth
2 |
3 | ## 0.0.2-rc.5
4 |
5 | ### Patch Changes
6 |
7 | - te4st
8 | - Updated dependencies
9 | - pocketpages-plugin-js-sdk@0.0.2-rc.5
10 | - pocketpages-plugin-auth@0.0.2-rc.5
11 | - pocketpages-plugin-ejs@0.0.2-rc.5
12 | - pocketpages@0.14.0-rc.5
13 |
14 | ## 0.0.2-rc.4
15 |
16 | ### Patch Changes
17 |
18 | - Testing
19 | - Updated dependencies
20 | - pocketpages-plugin-js-sdk@0.0.2-rc.4
21 | - pocketpages-plugin-auth@0.0.2-rc.4
22 | - pocketpages-plugin-ejs@0.0.2-rc.4
23 | - pocketpages@0.14.0-rc.4
24 |
25 | ## 0.0.2-rc.3
26 |
27 | ### Patch Changes
28 |
29 | - Publish testing
30 | - Updated dependencies
31 | - pocketpages-plugin-js-sdk@0.0.2-rc.3
32 | - pocketpages-plugin-auth@0.0.2-rc.3
33 | - pocketpages-plugin-ejs@0.0.2-rc.3
34 | - pocketpages@0.14.0-rc.3
35 |
36 | ## 0.0.2-rc.2
37 |
38 | ### Patch Changes
39 |
40 | - Publish testing
41 | - Updated dependencies
42 | - pocketpages-plugin-js-sdk@0.0.2-rc.2
43 | - pocketpages-plugin-auth@0.0.2-rc.2
44 | - pocketpages-plugin-ejs@0.0.2-rc.2
45 | - pocketpages@0.14.0-rc.2
46 |
47 | ## 0.0.2-rc.1
48 |
49 | ### Patch Changes
50 |
51 | - Publish testing
52 | - Updated dependencies
53 | - pocketpages-plugin-js-sdk@0.0.2-rc.1
54 | - pocketpages-plugin-auth@0.0.2-rc.1
55 | - pocketpages-plugin-ejs@0.0.2-rc.1
56 | - pocketpages@0.14.0-rc.1
57 |
58 | ## 0.0.2-rc.0
59 |
60 | ### Patch Changes
61 |
62 | - Updated dependencies
63 | - pocketpages@0.14.0-rc.0
64 | - pocketpages-plugin-auth@0.0.2-rc.0
65 | - pocketpages-plugin-ejs@0.0.2-rc.0
66 | - pocketpages-plugin-js-sdk@0.0.2-rc.0
67 |
--------------------------------------------------------------------------------
/packages/starters/auth/README.md:
--------------------------------------------------------------------------------
1 | # MPA Auth Demo
2 |
3 | This starter kit shows how to do Multi Page App (MPA) auth using PocketPages.
4 |
5 | ## Installation
6 |
7 | ```bash
8 | npx tiged benallfree/pocketpages/packages/starters/auth .
9 | cd auth
10 | npm i
11 | pocketbase --dir=pb_data --dev serve
12 | bunx maildev
13 | ```
14 |
15 | ## Notes
16 |
17 | ### Anonymous Login
18 |
19 | Anonymous login only works if Password login is enabled.
20 |
21 | ### Password Login
22 |
23 | Password login is enabled by default in PocketBase.
24 |
25 | ### OTP Login
26 |
27 | OTP login requires a verified email address.
28 |
29 | ### Using Password Reset
30 |
31 | Password Reset requires PocketBase's mail to be configured. The simplest localhost test is as follows:
32 |
33 | ```
34 | http://localhost:3000/reset-password
35 | ```
36 |
37 | ## App Configuration
38 |
39 | > This starter kit is already configured. In your own app, you'll need to update these settings
40 |
41 | **Step 1: Configure Mail Settings**
42 |
43 | In the PocketBase admin panel, navigate to `Settings > Mail Settings` and set the mail provider info to:
44 |
45 | Host: `localhost`
46 | Port: `1025`
47 | User: `(blank)`
48 | Password: `(blank)`
49 |
50 | **Step 2: Update Mail Template URLs**
51 |
52 | In the PocketBase admin panel, navigate to `Collections > Users > Edit > Options > Mail Templates` and update the URLs as follows:
53 |
54 | 1. Verification template: `{APP_URL}/auth/confirm/{TOKEN}/verification`
55 | 2. Reset Password template: `{APP_URL}/auth/confirm/{TOKEN}/password-reset`
56 | 3. Confirm email reset template: `{APP_URL}/auth/confirm/{TOKEN}/email-change`
57 |
--------------------------------------------------------------------------------
/packages/starters/auth/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "pocketpages-starter-auth",
3 | "private": true,
4 | "version": "0.0.2",
5 | "dependencies": {
6 | "pocketpages": "workspace:^0.17.0",
7 | "pocketpages-plugin-auth": "workspace:^0.2.0",
8 | "pocketpages-plugin-js-sdk": "workspace:^0.1.0"
9 | },
10 | "files": [
11 | "pb_hooks",
12 | "*.md"
13 | ],
14 | "description": "A starter project for PocketPages with authentication",
15 | "author": {
16 | "name": "Ben Allfree",
17 | "github": "benallfree"
18 | },
19 | "repository": {
20 | "type": "git",
21 | "url": "https://github.com/benallfree/pocketpages/tree/main/packages/starters/auth"
22 | },
23 | "keywords": [
24 | "pocketbase",
25 | "pockethost",
26 | "sqlite",
27 | "pocketpages",
28 | "starter",
29 | "auth"
30 | ],
31 | "license": "MIT"
32 | }
33 |
--------------------------------------------------------------------------------
/packages/starters/auth/pb_hooks/pages/+config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | plugins: [
3 | 'pocketpages-plugin-auth',
4 | 'pocketpages-plugin-js-sdk',
5 | 'pocketpages-plugin-ejs',
6 | ],
7 | debug: true,
8 | }
9 |
--------------------------------------------------------------------------------
/packages/starters/auth/pb_hooks/pages/+layout.ejs:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
52 | <%= params.__flash %>
53 |
54 | <% } %>
55 | <% if (auth && !auth.verified()) { %>
56 |
57 | Account not verified Resend Verification Email
58 |
59 | <% } %>
60 | 63 | <%- slot %> 64 |
Change Email
10 | 11 |
12 | Current email: <%= auth.get('email') %>
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/packages/starters/auth/pb_hooks/pages/account/index.ejs:
--------------------------------------------------------------------------------
1 | Account
2 |Welcome, <%= auth.get('email') %>
3 |Status: <%= auth.verified() ? 'verified' : 'unverified' %>
4 |Account tools
5 | -
6 |
- Change email address 7 |
Forgot Password
2 | <% if (data.error) { %> 3 | <%= data.error %> 4 | <% } %> 5 | -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/login/_private/anonymous.ejs: -------------------------------------------------------------------------------- 1 | 22 | 23 |Anonymous Login
24 | <% if (error) { %> 25 | <%= error %> 26 | <% } %> 27 | 28 | <% if (!methods.password.enabled) { %> 29 | Anonymous login is disabled. See README.md for details. 30 | <% } else { %> 31 | 35 | <% } %> -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/login/_private/mfa.ejs: -------------------------------------------------------------------------------- 1 | 8 | 9 |MFA Login
10 | <% if (error) { %> 11 | <%= error %> 12 | <% } %> 13 | <% if (!methods.mfa.enabled) { %> 14 | MFA Login is disabled. See README.md for details. 15 | <% } %> -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/login/_private/oauth2.ejs: -------------------------------------------------------------------------------- 1 | 33 | 34 | 35 |OAuth2 Login
36 | <% if (error) { %> 37 | <%= error %> 38 | <% } %> 39 | 40 | <% if (!methods.oauth2.enabled) { %> 41 | OAuth2 login is disabled. See README.md for details. 42 | <% } else {%> 43 | <% providers.forEach(provider => { %> 44 | 48 | <% }) %> 49 | <% if (providers.length === 0) { %> 50 | No OAuth2 providers enabled. See README.md for details. 51 | <% } %> 52 | <% } %> -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/login/_private/otp.ejs: -------------------------------------------------------------------------------- 1 | 8 |OTP Login
9 | <% if (error) { %> 10 | <%= error %> 11 | <% } %> 12 | <% if (!methods.otp.enabled) { %> 13 | OTP login is disabled. See README.md for details. 14 | <% } else { %> 15 | 21 | <% } %> -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/login/_private/password.ejs: -------------------------------------------------------------------------------- 1 | 27 |Password Login
28 | <% if (error) { %> 29 | <%= error %> 30 | <% } %> 31 | <% if (!methods.password.enabled) { %> 32 | Password login is disabled. See README.md for details. 33 | <% } else { %> 34 | 43 | <% } %> -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/login/index.ejs: -------------------------------------------------------------------------------- 1 |Login
2 | 3 |4 | <%- include('anonymous.ejs', ) %> 5 | 6 |
7 | <%- include('password.ejs',) %> 8 | 9 |
10 | <%- include('otp.ejs',) %> 11 | 12 |
13 | <%- include('oauth2.ejs',) %> 14 | 15 |
16 | <%- include('mfa.ejs',) %> -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/login/otp.ejs: -------------------------------------------------------------------------------- 1 | 36 | 37 | <%=error%> 38 | <% if (error) { %> 39 | <%= error %> 40 | <% } %> 41 | 42 |
We have sent you an OTP code
43 |Please check your email for the OTP code and enter it below.
44 | 51 | -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/logout/index.ejs: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/oauth/confirm.ejs: -------------------------------------------------------------------------------- 1 | 17 | <% if (error) { %> 18 | 19 | <%=error%> 20 | 21 | <% } %> -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/oauth/login.ejs: -------------------------------------------------------------------------------- 1 | 13 | <% if (error) { %> 14 | 15 | <%=error%> 16 | 17 | <% } %> -------------------------------------------------------------------------------- /packages/starters/auth/pb_hooks/pages/auth/register/index.ejs: -------------------------------------------------------------------------------- 1 | 16 |Register
17 | <% if (error) { %> 18 |<%= error %>
19 | <% } %>
20 |
--------------------------------------------------------------------------------
/packages/starters/auth/pb_hooks/pages/index.ejs:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/packages/starters/auth/pb_hooks/pocketpages.pb.js:
--------------------------------------------------------------------------------
1 | require('pocketpages')
2 |
--------------------------------------------------------------------------------
/packages/starters/auth/pb_migrations/1738509036_init.js:
--------------------------------------------------------------------------------
1 | /// Home
3 |Welcome to the PocketPages MPA Auth Demo
4 |Hello,
\nThank you for joining us at {APP_NAME}.
\nClick on the button below to verify your email address.
\n\n Verify\n
\n\n Thanks,
\n {APP_NAME} team\n
Hello,
\nThank you for joining us at {APP_NAME}.
\nClick on the button below to verify your email address.
\n\n Verify\n
\n\n Thanks,
\n {APP_NAME} team\n
Hello,
\nClick on the button below to reset your password.
\n\n Reset password\n
\nIf you didn't ask to reset your password, you can ignore this email.
\n\n Thanks,
\n {APP_NAME} team\n
Hello,
\nClick on the button below to reset your password.
\n\n Reset password\n
\nIf you didn't ask to reset your password, you can ignore this email.
\n\n Thanks,
\n {APP_NAME} team\n
Hello,
\nClick on the button below to confirm your new email address.
\n\n Confirm new email\n
\nIf you didn't ask to change your email address, you can ignore this email.
\n\n Thanks,
\n {APP_NAME} team\n
Hello,
\nClick on the button below to confirm your new email address.
\n\n Confirm new email\n
\nIf you didn't ask to change your email address, you can ignore this email.
\n\n Thanks,
\n {APP_NAME} team\n
2 |
3 |
--------------------------------------------------------------------------------
/packages/starters/daisyui-docs/pb_hooks/pages/(main)/docs/+layout.ejs:
--------------------------------------------------------------------------------
1 |
4 |
5 |
21 | <%- slot %>
22 |
23 |
24 |
25 |
29 |
30 |
2 |
3 |
25 |
--------------------------------------------------------------------------------
/packages/starters/daisyui-docs/pb_hooks/pages/(main)/docs/_private/toc.md:
--------------------------------------------------------------------------------
1 | # Getting Started
2 |
3 | - [Overview](/docs/overview)
4 |
--------------------------------------------------------------------------------
/packages/starters/daisyui-docs/pb_hooks/pages/(main)/docs/overview.md:
--------------------------------------------------------------------------------
1 | # Overview
2 |
3 | Edit this in `./pb_hooks/pages/(main)/docs/overview.md`
4 |
--------------------------------------------------------------------------------
/packages/starters/daisyui-docs/pb_hooks/pages/(splash)/+layout.ejs:
--------------------------------------------------------------------------------
1 |
4 |
10 | <%- slot %>
11 |
12 |
13 |
14 |
15 |
20 |
23 |
24 |
2 |
--------------------------------------------------------------------------------
/packages/starters/daisyui-docs/pb_hooks/pages/+config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | plugins: [
3 | { name: 'pocketpages-plugin-ejs', extensions: ['.ejs', '.md'] },
4 | 'pocketpages-plugin-marked',
5 | ],
6 | debug: true,
7 | }
8 |
--------------------------------------------------------------------------------
/packages/starters/daisyui-docs/pb_hooks/pages/+layout.ejs:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
3 |
10 |
4 |
9 | PocketPages
5 | 6 | 7 | Read the Docs 8 |
11 |
12 |
58 |
59 |
60 |
--------------------------------------------------------------------------------
/packages/starters/daisyui/pb_hooks/pages/app.tailwind.css:
--------------------------------------------------------------------------------
1 | @tailwind base;
2 | @tailwind components;
3 | @tailwind utilities;
4 |
--------------------------------------------------------------------------------
/packages/starters/daisyui/pb_hooks/pages/index.ejs:
--------------------------------------------------------------------------------
1 |
13 |
14 |
44 | <%- slot %>
45 |
46 |
47 |
52 |
56 |
57 |
2 |
18 |
--------------------------------------------------------------------------------
/packages/starters/daisyui/pb_hooks/pocketpages.pb.js:
--------------------------------------------------------------------------------
1 | require('pocketpages')
2 |
--------------------------------------------------------------------------------
/packages/starters/daisyui/tailwind.config.js:
--------------------------------------------------------------------------------
1 | /** @type {import('tailwindcss').Config} */
2 | export default {
3 | content: ['./pb_hooks/pages/**/*.{ejs,md}'],
4 | theme: {
5 | extend: {},
6 | },
7 | daisyui: {
8 | themes: ['cupcake'],
9 | },
10 | plugins: [require('@tailwindcss/typography'), require('daisyui')],
11 | }
12 |
--------------------------------------------------------------------------------
/packages/starters/deploy-fly-ga/.github/workflows/fly-deploy.yml:
--------------------------------------------------------------------------------
1 | # See https://fly.io/docs/app-guides/continuous-deployment-with-github-actions/
2 |
3 | name: Fly Deploy
4 | on:
5 | push:
6 | branches:
7 | - main
8 | jobs:
9 | deploy:
10 | name: Deploy app
11 | runs-on: ubuntu-latest
12 | concurrency: deploy-group # optional: ensure only one action runs at a time
13 | steps:
14 | - uses: actions/checkout@v4
15 | - uses: superfly/flyctl-actions/setup-flyctl@master
16 | - run: flyctl deploy --remote-only
17 | env:
18 | FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
19 |
--------------------------------------------------------------------------------
/packages/starters/deploy-fly-manual/.dockerignore:
--------------------------------------------------------------------------------
1 | # Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
2 |
3 | # Logs
4 |
5 | logs
6 | _.log
7 | npm-debug.log_
8 | yarn-debug.log*
9 | yarn-error.log*
10 | lerna-debug.log*
11 | .pnpm-debug.log*
12 |
13 | # Caches
14 |
15 | .cache
16 |
17 | # Diagnostic reports (https://nodejs.org/api/report.html)
18 |
19 | report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
20 |
21 | # Runtime data
22 |
23 | pids
24 | _.pid
25 | _.seed
26 | *.pid.lock
27 |
28 | # Directory for instrumented libs generated by jscoverage/JSCover
29 |
30 | lib-cov
31 |
32 | # Coverage directory used by tools like istanbul
33 |
34 | coverage
35 | *.lcov
36 |
37 | # nyc test coverage
38 |
39 | .nyc_output
40 |
41 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
42 |
43 | .grunt
44 |
45 | # Bower dependency directory (https://bower.io/)
46 |
47 | bower_components
48 |
49 | # node-waf configuration
50 |
51 | .lock-wscript
52 |
53 | # Compiled binary addons (https://nodejs.org/api/addons.html)
54 |
55 | build/Release
56 |
57 | # Dependency directories
58 |
59 | node_modules/
60 | jspm_packages/
61 |
62 | # Snowpack dependency directory (https://snowpack.dev/)
63 |
64 | web_modules/
65 |
66 | # TypeScript cache
67 |
68 | *.tsbuildinfo
69 |
70 | # Optional npm cache directory
71 |
72 | .npm
73 |
74 | # Optional eslint cache
75 |
76 | .eslintcache
77 |
78 | # Optional stylelint cache
79 |
80 | .stylelintcache
81 |
82 | # Microbundle cache
83 |
84 | .rpt2_cache/
85 | .rts2_cache_cjs/
86 | .rts2_cache_es/
87 | .rts2_cache_umd/
88 |
89 | # Optional REPL history
90 |
91 | .node_repl_history
92 |
93 | # Output of 'npm pack'
94 |
95 | *.tgz
96 |
97 | # Yarn Integrity file
98 |
99 | .yarn-integrity
100 |
101 | # dotenv environment variable files
102 |
103 | .env
104 | .env.development.local
105 | .env.test.local
106 | .env.production.local
107 | .env.local
108 |
109 | # parcel-bundler cache (https://parceljs.org/)
110 |
111 | .parcel-cache
112 |
113 | # Next.js build output
114 |
115 | .next
116 | out
117 |
118 | # Nuxt.js build / generate output
119 |
120 | .nuxt
121 | dist
122 |
123 | # Gatsby files
124 |
125 | # Comment in the public line in if your project uses Gatsby and not Next.js
126 |
127 | # https://nextjs.org/blog/next-9-1#public-directory-support
128 |
129 | # public
130 |
131 | # vuepress build output
132 |
133 | .vuepress/dist
134 |
135 | # vuepress v2.x temp and cache directory
136 |
137 | .temp
138 |
139 | # Docusaurus cache and generated files
140 |
141 | .docusaurus
142 |
143 | # Serverless directories
144 |
145 | .serverless/
146 |
147 | # FuseBox cache
148 |
149 | .fusebox/
150 |
151 | # DynamoDB Local files
152 |
153 | .dynamodb/
154 |
155 | # TernJS port file
156 |
157 | .tern-port
158 |
159 | # Stores VSCode versions used for testing VSCode extensions
160 |
161 | .vscode-test
162 |
163 | # yarn v2
164 |
165 | .yarn/cache
166 | .yarn/unplugged
167 | .yarn/build-state.yml
168 | .yarn/install-state.gz
169 | .pnp.*
170 |
171 | # IntelliJ based IDEs
172 | .idea
173 |
174 | # Finder (MacOS) folder config
175 | .DS_Store
176 |
177 |
178 | .ftp-deploy-sync-state.json
179 | pb_data
180 |
--------------------------------------------------------------------------------
/packages/starters/deploy-fly-manual/Dockerfile:
--------------------------------------------------------------------------------
1 | # syntax = docker/dockerfile:1
2 |
3 | # Adjust BUN_VERSION as desired
4 | ARG BUN_VERSION=1.1.26
5 | ARG NODE_VERSION=20
6 | FROM imbios/bun-node:${BUN_VERSION}-${NODE_VERSION}-alpine
7 |
8 | RUN apk add ca-certificates
9 |
10 | LABEL fly_launch_runtime="Bun"
11 |
12 | # Set production environment
13 | ENV NODE_ENV="production"
14 |
15 | WORKDIR /app-home
16 | COPY --link package.json .
17 | COPY --link bun.lockb .
18 | RUN bun i --production --verbose
19 | COPY --link . .
20 |
21 | # Start the server by default, this can be overwritten at runtime
22 | EXPOSE 8090
23 | CMD [ "bun", "serve", "--dev", "--dir=/pb_data", "--hooksDir=app" ]
24 |
--------------------------------------------------------------------------------
/packages/starters/deploy-fly-manual/fly.toml:
--------------------------------------------------------------------------------
1 | # fly.toml app configuration file generated for pocketpages on 2024-08-30T11:11:13-07:00
2 | #
3 | # See https://fly.io/docs/reference/configuration/ for information about how to use this file.
4 | #
5 |
6 | app = 'pocketpages'
7 | primary_region = 'sjc'
8 |
9 | [build]
10 |
11 | [http_service]
12 | internal_port = 8090
13 | force_https = true
14 | auto_stop_machines = 'stop'
15 | auto_start_machines = true
16 | min_machines_running = 0
17 | processes = ['app']
18 |
19 | [[vm]]
20 | memory = '1gb'
21 | cpu_kind = 'shared'
22 | cpus = 1
23 |
24 | [mounts]
25 | source = "pb_data"
26 | destination = "/pb_data"
--------------------------------------------------------------------------------
/packages/starters/deploy-pockethost-ga/.github/workflows/deploy-pockethost.yaml:
--------------------------------------------------------------------------------
1 | on:
2 | workflow_dispatch:
3 | push:
4 | branches:
5 | - main
6 | name: Deploy website on push
7 | jobs:
8 | deploy:
9 | name: Deploy
10 | runs-on: ubuntu-latest
11 | steps:
12 | - name: Get latest code
13 | uses: actions/checkout@v4
14 |
15 | - name: Sync files
16 | uses: SamKirkland/FTP-Deploy-Action@v4.3.5
17 | with:
18 | security: strict
19 | protocol: ftps
20 | server: ${{ secrets.ftp_server }}
21 | port: ${{ secrets.ftp_port }}
22 | username: ${{ secrets.ftp_username }}
23 | password: ${{ secrets.ftp_password }}
24 | local-dir: ./pb_hooks/
25 | server-dir: ./${{ secrets.app_name }}/
26 | log-level: verbose
27 | state-name: pb_hooks/.ftp-deploy-sync-state.json
28 | exclude: |
29 | **/.git*
30 | **/.git*/**
31 | **/node_modules/**
32 | .gitignore
33 | LICENSE
34 | README.md
35 |
--------------------------------------------------------------------------------
/packages/starters/deploy-pockethost-manual/.env-deploy-pockethost:
--------------------------------------------------------------------------------
1 | PH_USERNAME=your-pockethost-email
2 | PH_PASSWORD=your-pockethost-password
3 | APP_NAME=your-pockethost-instance-name
--------------------------------------------------------------------------------
/packages/starters/deploy-pockethost-manual/deploy-pockethost.ts:
--------------------------------------------------------------------------------
1 | import { deploy, excludeDefaults } from '@samkirkland/ftp-deploy'
2 | import 'dotenv/config'
3 | import env from 'env-var'
4 |
5 | async function deployMyCode() {
6 | console.log('🚚 Deploy started')
7 | await deploy({
8 | server: 'ftp.sfo-1.pockethost.io',
9 | username: env.get('PH_USERNAME').required().asString(),
10 | password: env.get('PH_PASSWORD').required().asString(),
11 | 'local-dir': 'pb_hooks/',
12 | 'server-dir': `${env.get('APP_NAME').required().asString()}/`,
13 | 'state-name': 'pb_hooks/.ftp-deploy-sync-state.json',
14 | exclude: [...excludeDefaults],
15 | 'log-level': 'verbose',
16 | })
17 | console.log('🚀 Deploy done!')
18 | }
19 |
20 | deployMyCode()
21 |
--------------------------------------------------------------------------------
/packages/starters/htmx/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # pocketpages-starter-htmx
2 |
3 | ## 0.0.2-rc.5
4 |
5 | ### Patch Changes
6 |
7 | - te4st
8 | - Updated dependencies
9 | - pocketpages-plugin-ejs@0.0.2-rc.5
10 | - pocketpages-plugin-sse@0.0.2-rc.5
11 | - pocketpages@0.14.0-rc.5
12 |
13 | ## 0.0.2-rc.4
14 |
15 | ### Patch Changes
16 |
17 | - Testing
18 | - Updated dependencies
19 | - pocketpages-plugin-ejs@0.0.2-rc.4
20 | - pocketpages-plugin-sse@0.0.2-rc.4
21 | - pocketpages@0.14.0-rc.4
22 |
23 | ## 0.0.2-rc.3
24 |
25 | ### Patch Changes
26 |
27 | - Publish testing
28 | - Updated dependencies
29 | - pocketpages-plugin-ejs@0.0.2-rc.3
30 | - pocketpages-plugin-sse@0.0.2-rc.3
31 | - pocketpages@0.14.0-rc.3
32 |
33 | ## 0.0.2-rc.2
34 |
35 | ### Patch Changes
36 |
37 | - Publish testing
38 | - Updated dependencies
39 | - pocketpages-plugin-ejs@0.0.2-rc.2
40 | - pocketpages-plugin-sse@0.0.2-rc.2
41 | - pocketpages@0.14.0-rc.2
42 |
43 | ## 0.0.2-rc.1
44 |
45 | ### Patch Changes
46 |
47 | - Publish testing
48 | - Updated dependencies
49 | - pocketpages-plugin-ejs@0.0.2-rc.1
50 | - pocketpages-plugin-sse@0.0.2-rc.1
51 | - pocketpages@0.14.0-rc.1
52 |
53 | ## 0.0.2-rc.0
54 |
55 | ### Patch Changes
56 |
57 | - Updated dependencies
58 | - pocketpages@0.14.0-rc.0
59 | - pocketpages-plugin-ejs@0.0.2-rc.0
60 | - pocketpages-plugin-sse@0.0.2-rc.0
61 |
--------------------------------------------------------------------------------
/packages/starters/htmx/README.md:
--------------------------------------------------------------------------------
1 | # htmx Starter Kit
2 |
3 | This starter kit is based on the [htmx](https://htmx.org/) project. It is designed to help you get started with a minimal, responsive, and mobile-friendly website using PocketPages.
4 |
5 | ## Installation
6 |
7 | ```bash
8 | npx tiged benallfree/pocketpages/packages/starters/htmx .
9 | cd htmx
10 | npm i
11 | pocketbase serve --dir=pb_data --dev
12 | ```
13 |
--------------------------------------------------------------------------------
/packages/starters/htmx/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "pocketpages-starter-htmx",
3 | "version": "0.0.2",
4 | "private": true,
5 | "dependencies": {
6 | "pocketpages": "workspace:^0.16.0",
7 | "pocketpages-plugin-sse": "workspace:^0.1.0"
8 | },
9 | "files": [
10 | "pb_hooks",
11 | "*.md"
12 | ],
13 | "description": "A starter project for PocketPages with htmx",
14 | "author": {
15 | "name": "Ben Allfree",
16 | "github": "benallfree"
17 | },
18 | "repository": {
19 | "type": "git",
20 | "url": "https://github.com/benallfree/pocketpages/tree/main/packages/starters/htmx"
21 | },
22 | "keywords": [
23 | "pocketpages",
24 | "starter",
25 | "htmx"
26 | ],
27 | "license": "MIT"
28 | }
29 |
--------------------------------------------------------------------------------
/packages/starters/htmx/pb_hooks/pages/(site)/+layout.ejs:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
3 |
17 |
4 |
16 | Daisy UI
5 |The official PocketPages starter kit.
6 |
7 |
9 | code .
10 | Ready to rumble with:
11 |
15 | -
12 |
- Daisy UI 13 |
htmx realtime demo
2 |This is a demo shows you how to use htmx to build a realtime app.
3 | 4 |
32 | Counter
33 |
--------------------------------------------------------------------------------
/packages/starters/htmx/pb_hooks/pages/+config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | plugins: ['pocketpages-plugin-ejs', 'pocketpages-plugin-sse'],
3 | }
4 |
--------------------------------------------------------------------------------
/packages/starters/htmx/pb_hooks/pages/_private/count.ejs:
--------------------------------------------------------------------------------
1 | <%= store('count')||1 %>
2 |
--------------------------------------------------------------------------------
/packages/starters/htmx/pb_hooks/pages/api/chat.ejs:
--------------------------------------------------------------------------------
1 |
7 |
8 | <%= message %>
9 |
--------------------------------------------------------------------------------
/packages/starters/htmx/pb_hooks/pages/api/count.ejs:
--------------------------------------------------------------------------------
1 |
6 | <%- include('count.ejs') %>
--------------------------------------------------------------------------------
/packages/starters/htmx/pb_hooks/pocketpages.pb.js:
--------------------------------------------------------------------------------
1 | require('pocketpages')
2 |
--------------------------------------------------------------------------------
/packages/starters/minimal/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # minimal
2 |
3 | ## 0.0.2-rc.5
4 |
5 | ### Patch Changes
6 |
7 | - te4st
8 | - Updated dependencies
9 | - pocketpages-plugin-ejs@0.0.2-rc.5
10 | - pocketpages@0.14.0-rc.5
11 |
12 | ## 0.0.2-rc.4
13 |
14 | ### Patch Changes
15 |
16 | - Testing
17 | - Updated dependencies
18 | - pocketpages-plugin-ejs@0.0.2-rc.4
19 | - pocketpages@0.14.0-rc.4
20 |
21 | ## 0.0.2-rc.3
22 |
23 | ### Patch Changes
24 |
25 | - Publish testing
26 | - Updated dependencies
27 | - pocketpages-plugin-ejs@0.0.2-rc.3
28 | - pocketpages@0.14.0-rc.3
29 |
30 | ## 0.0.2-rc.2
31 |
32 | ### Patch Changes
33 |
34 | - Publish testing
35 | - Updated dependencies
36 | - pocketpages-plugin-ejs@0.0.2-rc.2
37 | - pocketpages@0.14.0-rc.2
38 |
39 | ## 0.0.2-rc.1
40 |
41 | ### Patch Changes
42 |
43 | - Publish testing
44 | - Updated dependencies
45 | - pocketpages-plugin-ejs@0.0.2-rc.1
46 | - pocketpages@0.14.0-rc.1
47 |
48 | ## 0.0.2-rc.0
49 |
50 | ### Patch Changes
51 |
52 | - Updated dependencies
53 | - pocketpages@0.14.0-rc.0
54 | - pocketpages-plugin-ejs@0.0.2-rc.0
55 |
--------------------------------------------------------------------------------
/packages/starters/minimal/README.md:
--------------------------------------------------------------------------------
1 | # Minimal PocketPages Starter Kit
2 |
3 | ## Installation
4 |
5 | ```bash
6 | npx tiged benallfree/pocketpages/starters/minimal .
7 | cd minimal
8 | pocketbase --dir=pb_data --dev serve
9 | ```
10 |
--------------------------------------------------------------------------------
/packages/starters/minimal/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "pocketpages-starter-minimal",
3 | "private": true,
4 | "version": "0.0.2",
5 | "dependencies": {
6 | "pocketpages": "workspace:^0.16.0"
7 | },
8 | "pockethost": {
9 | "instanceId": "minimal"
10 | },
11 | "files": [
12 | "pb_hooks",
13 | "*.md"
14 | ],
15 | "description": "A minimal starter project for PocketPages",
16 | "author": {
17 | "name": "Ben Allfree",
18 | "github": "benallfree"
19 | },
20 | "repository": {
21 | "type": "git",
22 | "url": "https://github.com/benallfree/pocketpages/tree/main/packages/starters/minimal"
23 | },
24 | "keywords": [
25 | "pocketpages",
26 | "starter",
27 | "minimal"
28 | ],
29 | "license": "MIT"
30 | }
31 |
--------------------------------------------------------------------------------
/packages/starters/minimal/pb_hooks/pages/index.ejs:
--------------------------------------------------------------------------------
1 | <%= `Hello, PocketPages` %>
2 |
--------------------------------------------------------------------------------
/packages/starters/minimal/pb_hooks/pocketpages.pb.js:
--------------------------------------------------------------------------------
1 | require('pocketpages')
2 |
--------------------------------------------------------------------------------
/packages/starters/mvp/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # mvp
2 |
3 | ## 0.0.2-rc.5
4 |
5 | ### Patch Changes
6 |
7 | - te4st
8 | - Updated dependencies
9 | - pocketpages-plugin-ejs@0.0.2-rc.5
10 | - pocketpages@0.14.0-rc.5
11 |
12 | ## 0.0.2-rc.4
13 |
14 | ### Patch Changes
15 |
16 | - Testing
17 | - Updated dependencies
18 | - pocketpages-plugin-ejs@0.0.2-rc.4
19 | - pocketpages@0.14.0-rc.4
20 |
21 | ## 0.0.2-rc.3
22 |
23 | ### Patch Changes
24 |
25 | - Publish testing
26 | - Updated dependencies
27 | - pocketpages-plugin-ejs@0.0.2-rc.3
28 | - pocketpages@0.14.0-rc.3
29 |
30 | ## 0.0.2-rc.2
31 |
32 | ### Patch Changes
33 |
34 | - Publish testing
35 | - Updated dependencies
36 | - pocketpages-plugin-ejs@0.0.2-rc.2
37 | - pocketpages@0.14.0-rc.2
38 |
39 | ## 0.0.2-rc.1
40 |
41 | ### Patch Changes
42 |
43 | - Publish testing
44 | - Updated dependencies
45 | - pocketpages-plugin-ejs@0.0.2-rc.1
46 | - pocketpages@0.14.0-rc.1
47 |
48 | ## 0.0.2-rc.0
49 |
50 | ### Patch Changes
51 |
52 | - Updated dependencies
53 | - pocketpages@0.14.0-rc.0
54 | - pocketpages-plugin-ejs@0.0.2-rc.0
55 |
--------------------------------------------------------------------------------
/packages/starters/mvp/README.md:
--------------------------------------------------------------------------------
1 | # PocketPages Starter Kit for MVPs
2 |
3 | This starter kit is based on the [MVP.css](https://andybrewer.github.io/mvp/) project. It is designed to help you get started with a minimal, responsive, and mobile-friendly website using PocketPages.
4 |
5 | ## Installation
6 |
7 | ```bash
8 | npx tiged benallfree/pocketpages/starters/mvp .
9 | cd mvp
10 | pocketbase --dir=pb_data --dev serve
11 | ```
12 |
--------------------------------------------------------------------------------
/packages/starters/mvp/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "pocketpages-starter-mvp",
3 | "version": "0.0.2",
4 | "private": true,
5 | "description": "A minimal PocketBase project using the MVP.css framework",
6 | "author": {
7 | "name": "Ben Allfree",
8 | "github": "benallfree"
9 | },
10 | "repository": {
11 | "type": "git",
12 | "url": "https://github.com/benallfree/pocketpages/packages/starters/mvp"
13 | },
14 | "dependencies": {
15 | "pocketpages": "workspace:^0.16.0"
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/packages/starters/mvp/pb_hooks/pages/index.ejs:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | Welcome to PocketPages
15 |This is a starter page using MVP.css.
16 |