Initialize JSON Schema endpoint (#1)

* setup example

* Refine PRD

* Adds Caddyfile

* remove hono app

* init example registry

* update favicon

* format

* init json schema api

* update deps

* refacroe forge models export pattern

* refactor schema endpoint structure

* Fix registry example

* cleanup internal deps

Author: OllieJT

.github/workflows/deploy-api.yml

@@ -0,0 +1,39 @@
+name: Deploy API to GitHub Pages
+
+on:
+  # Trigger the workflow every time you push to the `main` branch
+  # Using a different branch name? Replace `main` with your branch’s name
+  push:
+    branches: [ main ]
+  # Allows you to run this workflow manually from the Actions tab on GitHub.
+  workflow_dispatch:
+
+# Allow this job to clone the repo and create a page deployment
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v4
+      - name: Install, build, and upload your site
+        uses: withastro/action@v3
+        with:
+          path: apps/api # The root location of your Astro project inside the repository. (optional)
+          # node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 20. (optional)
+          # package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.vscode/extensions.json

@@ -9,7 +9,6 @@
 		// Astro - Syntax Highlighting
 		"astro-build.astro-vscode",
 
-
 		// MDX - JSX in markdown
 		"unifiedjs.vscode-mdx"
 	],

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
 	// Triggers biome formatting on save.
-	"[json][typescript][javascript][tsx][html][css][postcss][sql]": {
+	"[json][typescript][javascript][tsx][html][css][postcss][sql][astro]": {
 		"editor.codeActionsOnSave": {
 			"source.fixAll.ts": "explicit",
 			"source.organizeImports": "explicit"

CONTRIBUTING

@@ -92,6 +92,10 @@ The source code for the official [Documentation Website](https://docs.dhfs.dev),
 `/apps/schema`
 Infrastructure for publishing and hosting the generated JSON Schema files, making them available at [schema.dhfs.dev](https://schema.dhfs.dev).
 
+#### ⚡️ registry
+`/apps/registry`
+A working demonstration of a hosted repository. Available at [repo.dhfs.dev](https://repo.dhfs.dev).
+
 ### GitHub
 `/.github/`
 Contains GitHub-specific files, including workflow definitions for CI/CD.

Caddyfile

@@ -0,0 +1,40 @@
+{
+	local_certs
+	email contact@dhfs.dev
+}
+
+
+api.localhost {
+	encode gzip
+
+	# Vide node modules
+	handle /node_modules/* {
+		reverse_proxy localhost:4321
+	}
+
+	reverse_proxy localhost:4321
+}
+
+
+docs.localhost {
+	encode gzip
+
+	# Vide node modules
+	handle /node_modules/* {
+		reverse_proxy localhost:4322
+	}
+
+	reverse_proxy localhost:4322
+}
+
+
+registry.localhost {
+	encode gzip
+
+	# Vide node modules
+	handle /node_modules/* {
+		reverse_proxy localhost:5173
+	}
+
+	reverse_proxy localhost:5173
+}

README.PRD.md

@@ -57,6 +57,7 @@ This repository uses a monorepo structure to manage different parts of the DHFS
 - `/packages/forge-models`: This is the heart\! It contains the **Zod schemas** which serve as the single source of truth for defining all DHFS data structures. Typescript types and JSON Schemas are generated from here.
 - `/apps/docs`: Houses the source code for our [Documentation Website](https://docs.dhfs.dev).
 - `/apps/schema`: Contains the necessary files and infrastructure to publish and host the generated **JSON Schema files**. This makes the machine-readable schemas available at stable, versioned URLs like [schema.dhfs.dev/v1](https://schema.dhfs.dev/v1).
+- `/apps/registry`: A working demonstration of a hosted repository. Available at [repo.dhfs.dev](https://repo.dhfs.dev).
 - _(Other internal packages may exist but are primarily for development support)._
 
 ## Further Reading & Governance

README.md

@@ -0,0 +1,24 @@
+# build output
+dist/
+
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/

apps/api/.gitignore

@@ -0,0 +1,48 @@
+# Astro Starter Kit: Basics
+
+```sh
+pnpm create astro@latest -- --template basics
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
+
+## 🚀 Project Structure
+
+Inside of your Astro project, you'll see the following folders and files:
+
+```text
+/
+├── public/
+│   └── favicon.svg
+├── src/
+│   ├── layouts/
+│   │   └── Layout.astro
+│   └── pages/
+│       └── index.astro
+└── package.json
+```
+
+To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/).
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `pnpm install`             | Installs dependencies                            |
+| `pnpm dev`             | Starts local dev server at `localhost:4321`      |
+| `pnpm build`           | Build your production site to `./dist/`          |
+| `pnpm preview`         | Preview your build locally, before deploying     |
+| `pnpm astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `pnpm astro -- --help` | Get help using the Astro CLI                     |
+
+## 👀 Want to learn more?
+
+Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).

apps/api/README.md

@@ -0,0 +1,20 @@
+// @ts-check
+import { defineConfig } from "astro/config";
+
+import sitemap from "@astrojs/sitemap";
+
+import tailwindcss from "@tailwindcss/vite";
+
+// https://astro.build/config
+export default defineConfig({
+  site: "https://api.dhfs.dev",
+  integrations: [sitemap()],
+
+  server: {
+      port: 4321,
+	},
+
+  vite: {
+    plugins: [tailwindcss()],
+  },
+});