Merge pull request #1655 from cprussin/add-api-reference

feat(api-reference): initialize api reference app

Author: cprussin

.gitignore

@@ -21,3 +21,4 @@ __pycache__
 .DS_Store
 .vercel
 .direnv
+.next

.prettierignore

@@ -1,2 +1,15 @@
 pnpm-lock.yaml
 patches/
+
+# This app has it's own prettier config that uses a later version of prettier
+#
+# TODO(cprussin): eventually I'll figure out how to upgrade prettier everywhere
+# and hook it in to pre-commit.  For now, I don't want to downgrade prettier in
+# the pcakage that's using the later version, and pre-commit doesn't support
+# later versions of prettier directly.
+#
+# Ideally, we should probably hook up a pre-commit script to run auto-fixes in a
+# generic way that packages can hook into by defining lifecycle scripts, or by
+# using the nx task graph.  Then, packages can use their own formatters /
+# formatter versions and can also hook up other auto-fixes like eslint, etc.
+apps/api-reference

apps/api-reference/.prettierignore

@@ -0,0 +1,8 @@
+# Copied from .gitignore
+.next/
+coverage/
+node_modules/
+*.tsbuildinfo
+.env*.local
+.env
+.DS_Store

apps/api-reference/eslint.config.js

@@ -0,0 +1,18 @@
+import { fileURLToPath } from "node:url";
+
+import { nextjs, tailwind, storybook } from "@cprussin/eslint-config";
+
+const tailwindConfig = fileURLToPath(
+  import.meta.resolve(`./tailwind.config.ts`),
+);
+
+export default [
+  ...nextjs,
+  ...tailwind(tailwindConfig),
+  ...storybook,
+  {
+    rules: {
+      "turbo/no-undeclared-env-vars": "off",
+    },
+  },
+];

apps/api-reference/jest.config.js

@@ -0,0 +1 @@
+export { nextjs as default } from "@cprussin/jest-config";

apps/api-reference/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

apps/api-reference/next.config.js

@@ -0,0 +1,59 @@
+import withMDX from "@next/mdx";
+
+const config = {
+  reactStrictMode: true,
+
+  pageExtensions: ["ts", "tsx", "mdx"],
+
+  logging: {
+    fetches: {
+      fullUrl: true,
+    },
+  },
+
+  webpack(config) {
+    config.module.rules.push({
+      test: /\.svg$/i,
+      use: ["@svgr/webpack"],
+    });
+
+    config.resolve.extensionAlias = {
+      ".js": [".js", ".ts", ".tsx"],
+    };
+
+    return config;
+  },
+
+  transpilePackages: ["@pyth.network/*"],
+
+  headers: () => [
+    {
+      source: "/:path*",
+      headers: [
+        {
+          key: "X-XSS-Protection",
+          value: "1; mode=block",
+        },
+        {
+          key: "Referrer-Policy",
+          value: "strict-origin-when-cross-origin",
+        },
+        {
+          key: "Strict-Transport-Security",
+          value: "max-age=2592000",
+        },
+        {
+          key: "X-Content-Type-Options",
+          value: "nosniff",
+        },
+        {
+          key: "Permissions-Policy",
+          value:
+            "vibrate=(), geolocation=(), midi=(), notifications=(), push=(), sync-xhr=(), microphone=(), camera=(), magnetometer=(), gyroscope=(), speaker=(), vibrate=(), fullscreen=self",
+        },
+      ],
+    },
+  ],
+};
+
+export default withMDX()(config);

apps/api-reference/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@pythnetwork/api-reference",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "engines": {
+    "node": "18"
+  },
+  "scripts": {
+    "build": "next build",
+    "fix": "pnpm fix:format && pnpm fix:lint",
+    "fix:format": "prettier --write .",
+    "fix:lint": "eslint --fix .",
+    "start:dev": "next dev",
+    "start:prod": "next start",
+    "test": "tsc && jest",
+    "test:format": "jest --selectProjects format",
+    "test:lint": "jest --selectProjects lint",
+    "test:types": "tsc",
+    "test:unit": "jest --selectProjects unit --passWithNoTests"
+  },
+  "dependencies": {
+    "@amplitude/analytics-browser": "^2.8.1",
+    "@floating-ui/react": "^0.26.16",
+    "@headlessui/react": "^2.0.4",
+    "@heroicons/react": "^2.1.3",
+    "@mdx-js/loader": "^3.0.1",
+    "@mdx-js/mdx": "^3.0.1",
+    "@mdx-js/react": "^3.0.1",
+    "@next/mdx": "^14.2.3",
+    "@next/third-parties": "^14.2.3",
+    "@pythnetwork/pyth-sdk-solidity": "^3.1.0",
+    "@wagmi/core": "^2.10.5",
+    "clsx": "^2.1.1",
+    "next": "^14.2.3",
+    "next-themes": "^0.3.0",
+    "pino": "^9.1.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "shiki": "^1.6.2",
+    "viem": "^2.13.3",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@axe-core/react": "^4.9.1",
+    "@cprussin/eslint-config": "^3.0.0",
+    "@cprussin/jest-config": "^1.4.1",
+    "@cprussin/prettier-config": "^2.1.1",
+    "@cprussin/tsconfig": "^3.0.1",
+    "@svgr/webpack": "^8.1.0",
+    "@tailwindcss/forms": "^0.5.7",
+    "@types/jest": "^29.5.12",
+    "@types/mdx": "^2.0.13",
+    "@types/node": "^20.14.0",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "autoprefixer": "^10.4.19",
+    "eslint": "^9.4.0",
+    "jest": "^29.7.0",
+    "postcss": "^8.4.38",
+    "prettier": "^3.3.0",
+    "tailwindcss": "^3.4.3",
+    "typescript": "^5.4.5",
+    "vercel": "^34.2.4"
+  }
+}

apps/api-reference/postcss.config.js

@@ -0,0 +1,6 @@
+export default {
+  plugins: {
+    autoprefixer: {},
+    tailwindcss: {},
+  },
+};

apps/api-reference/prettier.config.js

@@ -0,0 +1,9 @@
+import { fileURLToPath } from "node:url";
+
+import { base, tailwind, mergeConfigs } from "@cprussin/prettier-config";
+
+const tailwindConfig = fileURLToPath(
+  import.meta.resolve(`./tailwind.config.ts`),
+);
+
+export default mergeConfigs([base, tailwind(tailwindConfig)]);