Skip to content

Issue #39: Subscription guide (enhancement) - #42

Open
YugBargaway2006 wants to merge 2 commits into
metakgp:mainfrom
YugBargaway2006:subscription_guide
Open

YugBargaway2006 wants to merge 2 commits into
metakgp:mainfrom
YugBargaway2006:subscription_guide

Conversation

@YugBargaway2006

Copy link
Copy Markdown

Description

Adds a publicly accessible /guide route to the Naarad frontend and renders the existing SUBSCRIPTION_INSTRUCTION.md file.

This addresses issue #39, “Host Subscription Guide on Frontend”. Users can access the subscription instructions without signing in and navigate to the registration page from the guide.

The existing registration flow, authentication behavior, Docker configuration, backend, and NTFY credentials remain unchanged.

Fixes # (39)

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

  • Production build completed successfully with pnpm run build.
  • Verified the guide renders at /guide in the local frontend.
  • Verified the registration page remains accessible and links to the guide.
  • Verified the guide is accessible without authentication.

Reproduction

cd frontend
pnpm install
pnpm run build
pnpm run dev
open http://localhost:3000/guide

Test Configuration:

  • Node.js: 22
  • Package manager: pnpm
  • Framework: SolidJS with Vite
  • Browser: Google Chrome (Chromium-based browser)
  • Deployment target: GitHub Pages

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copilot AI balanced review requested due to automatic review settings October 4, 2026 05:28

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@YugBargaway2006
YugBargaway2006 requested a balanced review from Copilot October 4, 2026 15:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@proffapt

proffapt commented Oct 5, 2026

Copy link
Copy Markdown
Member

@YugBargaway2006 can you share a screenshot from your local build?

@YugBargaway2006

Copy link
Copy Markdown
Author
image

The steps I followed for the fix, maybe this help to find out the issue faced,

  1. After the docker compose, it was not visible at http://localhost:8000/ in my system, so I created a docker compose override, with the following to make it visible on localhost. I haven't push this change.
services:
  naarad:
    ports:
      - "8000:8000"
  1. I went to the frontend directory and pnpm run dev which runs at localhost:3000, and changed things only in the frontend directory since the guide is to be hosted on frontend itself at /guide, i.e., http://localhost:3000/guide
    The changes were,
    a. 404.html file to route to /guide if a user directly opens or refreshes to /guide
    b. Adding the route of guide in app.tsx
    c. Guide.tsx to render markdown Subscription Guide and its .scss file

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants