Initial commit

.dockerignore

@@ -0,0 +1,5 @@
+node_modules
+.git
+.gitignore
+*.md
+dist

.eslintignore

@@ -0,0 +1,13 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+
+# Ignore files for PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock

.eslintrc.cjs

@@ -0,0 +1,31 @@
+/** @type { import("eslint").Linter.Config } */
+module.exports = {
+	root: true,
+	extends: [
+		'eslint:recommended',
+		'plugin:@typescript-eslint/recommended',
+		'plugin:svelte/recommended',
+		'prettier'
+	],
+	parser: '@typescript-eslint/parser',
+	plugins: ['@typescript-eslint'],
+	parserOptions: {
+		sourceType: 'module',
+		ecmaVersion: 2020,
+		extraFileExtensions: ['.svelte']
+	},
+	env: {
+		browser: true,
+		es2017: true,
+		node: true
+	},
+	overrides: [
+		{
+			files: ['*.svelte'],
+			parser: 'svelte-eslint-parser',
+			parserOptions: {
+				parser: '@typescript-eslint/parser'
+			}
+		}
+	]
+};

.github/workflows/conventional-commits-check.yaml

@@ -0,0 +1,15 @@
+name: Conventional Commits Check
+
+on:
+  pull_request:
+    branches: [develop]
+
+jobs:
+  check-conventional-commits:
+    name: Conventional Commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check Commit Conventions
+        uses: webiny/[email protected]

.github/workflows/docker-deploy.yaml

@@ -0,0 +1,30 @@
+name: Build and push Docker image
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-push:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: get-npm-version
+        id: package-version
+        uses: martinbeentjes/[email protected]
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: Mokto
+          password: ${{ secrets.PAT }}
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          push: true
+          tags: ghcr.io/mokto/apihero:${{ steps.package-version.outputs.current-version}}

.github/workflows/release.yaml

@@ -0,0 +1,20 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Release Please Action
+        uses: google-github-actions/release-please-action@v4
+        with:
+          token: ${{ secrets.PAT }}
+          config-file: release-please-config.json

.gitignore

@@ -0,0 +1,16 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
+
+openapi.db
+dist
+openapi.json
+
+openapi-files

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

.prettierignore

@@ -0,0 +1,4 @@
+# Ignore files for PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock

.prettierrc

@@ -0,0 +1,8 @@
+{
+	"useTabs": true,
+	"singleQuote": true,
+	"trailingComma": "none",
+	"printWidth": 100,
+	"plugins": ["prettier-plugin-svelte"],
+	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
+}

.release-please-manifest.json

@@ -0,0 +1 @@
+{".":"0.1.2"}

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+	"[svelte]": {
+		"editor.defaultFormatter": "svelte.svelte-vscode"
+	},
+	"[javascript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode",
+		"editor.formatOnSave": true
+	},
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"editor.formatOnSave": true
+}

CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## [0.1.2](https://github.com/Mokto/apihero/compare/apihero-v0.1.1...apihero-v0.1.2) (2024-05-10)
+
+
+### Bug Fixes
+
+* build ([0dffcc9](https://github.com/Mokto/apihero/commit/0dffcc9d5b996caa41c97030c38fa564d39e46af))
+
+## [0.1.1](https://github.com/Mokto/apihero/compare/apihero-v0.1.0...apihero-v0.1.1) (2024-05-10)
+
+
+### Bug Fixes
+
+* deployment ([5630def](https://github.com/Mokto/apihero/commit/5630deff482faeda38ff8a5b4aaab49e5296a3c9))
+
+## [0.1.0](https://github.com/Mokto/apihero/compare/apihero-v0.0.1...apihero-v0.1.0) (2024-05-10)
+
+
+### Features
+
+* added markdown to the exported library ([705b8a7](https://github.com/Mokto/apihero/commit/705b8a73874a1e85a04871b0d010555fe0941c0c))
+* empty state ([9cc74c4](https://github.com/Mokto/apihero/commit/9cc74c4a7f549b9949fadafa7d6ec040ae674f3d))
+* improved design ([5dd7966](https://github.com/Mokto/apihero/commit/5dd79663a8672255d5202339b985d97255e8f9a1))
+* markdoc ([fb83cb5](https://github.com/Mokto/apihero/commit/fb83cb57d10001f6c275966a05cac66d846c1b78))
+* save data into a libsql database ([4a5e2c1](https://github.com/Mokto/apihero/commit/4a5e2c115df5a36d3e244825b68a2052f1c5c113))
+* support mobile size ([553ceb6](https://github.com/Mokto/apihero/commit/553ceb6bb34a0b4985c108d1af08700887e30bc5))
+* supports a favicon & a meta title ([9c27190](https://github.com/Mokto/apihero/commit/9c27190b3045ee3c1cba630aeafad72de5fbbe2a))
+* supports connecting to turso ([2b4b141](https://github.com/Mokto/apihero/commit/2b4b141db264ec0faca8521da5a3e4b889a1d10e))
+* supports deprecated & more boolean property details ([42e35ad](https://github.com/Mokto/apihero/commit/42e35ad464bdd1d915fa4804f2874592c2b89602))
+* webhooks support ([2a839d3](https://github.com/Mokto/apihero/commit/2a839d3d5da3a03707b68af39a925816f51de076))
+
+
+### Bug Fixes
+
+* added db to gitignore ([40df3af](https://github.com/Mokto/apihero/commit/40df3af380dc0f97b32c60909962739cb8fd2369))
+* few design & ux issues ([d466721](https://github.com/Mokto/apihero/commit/d46672117af2872e28bef796dd85647999e40bfc))
+* navigation ([b8bdc50](https://github.com/Mokto/apihero/commit/b8bdc50b574f2f348fae2c189ea43d723785ef56))
+* navigation issues ([286ef36](https://github.com/Mokto/apihero/commit/286ef369464ec96c1fe48ffd6099cc170f749e9c))
+* operation not found 500 ([7f75953](https://github.com/Mokto/apihero/commit/7f759539ca35ce23c5d616775562facf944187e6))
+* removed autogenerated db ([98bd30b](https://github.com/Mokto/apihero/commit/98bd30b777ff071ab9f24b9cd22357d7f95f49e1))

Dockerfile

@@ -0,0 +1,25 @@
+FROM node:20-slim AS base
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
+COPY . /app
+WORKDIR /app
+
+FROM base AS prod-deps
+RUN pnpm install --prod --frozen-lockfile
+
+FROM base AS build
+RUN pnpm install --frozen-lockfile
+RUN pnpm run build
+RUN pnpm prune --production
+
+FROM base
+COPY --from=prod-deps /app/node_modules /app/node_modules
+COPY --from=build /app/build /app/build
+
+EXPOSE 3000
+ENV NODE_ENV=production
+ENV PORT 3000
+ENV HOST 0.0.0.0
+
+CMD [ "node", "build" ]

README.md

@@ -0,0 +1,12 @@
+# TODO
+
+- Add arrows to navigate to next/previous page
+
+- Search
+
+- Meta (title + favicon)
+
+## ENV variables
+
+PUBLIC_TITLE -> for the meta title tag
+PUBLIC_FAVICON_SVG -> for the favicon. only supports svg for now

package.json

@@ -0,0 +1,65 @@
+{
+	"name": "apihero",
+	"version": "0.1.2",
+	"private": true,
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build",
+		"preview": "vite preview",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+		"package": "svelte-kit sync && svelte-package && publint",
+		"prepublishOnly": "npm run package",
+		"lint": "prettier --check . && eslint .",
+		"format": "prettier --write ."
+	},
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"svelte": "./dist/index.js"
+		}
+	},
+	"files": [
+		"dist",
+		"!dist/**/*.test.*",
+		"!dist/**/*.spec.*"
+	],
+	"svelte": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"devDependencies": {
+		"@sveltejs/adapter-auto": "3.2.0",
+		"@sveltejs/adapter-node": "5.0.1",
+		"@sveltejs/vite-plugin-svelte": "3.1.0",
+		"@types/eslint": "8.56.10",
+		"@types/node": "20.12.8",
+		"@typescript-eslint/eslint-plugin": "7.8.0",
+		"@typescript-eslint/parser": "7.8.0",
+		"autoprefixer": "10.4.19",
+		"eslint": "8.56.0",
+		"eslint-config-prettier": "9.1.0",
+		"eslint-plugin-svelte": "2.38.0",
+		"postcss": "8.4.38",
+		"prettier": "3.2.5",
+		"prettier-plugin-svelte": "3.2.3",
+		"publint": "^0.2.7",
+		"svelte-check": "3.7.0",
+		"tailwindcss": "3.4.3",
+		"tslib": "2.6.2",
+		"typescript": "5.4.5",
+		"vite": "5.2.10"
+	},
+	"type": "module",
+	"dependencies": {
+		"svelte": "4.2.15",
+		"@fontsource-variable/rethink-sans": "5.0.4",
+		"@fontsource-variable/source-code-pro": "5.0.19",
+		"@markdoc/markdoc": "^0.4.0",
+		"@sveltejs/kit": "^2.5.7",
+		"@sveltejs/package": "^2.3.1",
+		"highlight.js": "11.9.0",
+		"libsql": "0.3.18",
+		"oas": "24.3.1",
+		"openapi-types": "12.1.3",
+		"svhighlight": "0.7.1"
+	}
+}