Merge pull request #93 from steniowagner/feat/project-documentation

chore: generating docs using spectaql
steniowagner · Feb 17, 2024 · 633a0e6 · 633a0e6
2 parents 034a955 + 4162c87
commit 633a0e6
Show file tree

Hide file tree

Showing 10 changed files with 8,926 additions and 53 deletions.
diff --git a/.env.example b/.env.example
@@ -1,3 +1,4 @@
 NEWS_API_KEY=<YOUR_NEWS_API_KEY>
 THE_MOVIE_DB_API_READ_ACCESS_TOKEN=<YOUR_THE_MOVIE_DB_API_READ_ACCESS_TOKEN>
 PORT=<PORT>
+STEP_ZEN_KEY=<YOUR_STEP_ZEN_KEY>
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -3,5 +3,9 @@
 
 npm run prettier:fix
 npm run lint:fix
-npm run test
 npm run build
+npm run test
+rm -rf docs
+mkdir docs
+npx spectaql spectaql-config.yaml -t ./docs
+git add -A .
diff --git a/docs/images/logo.png b/docs/images/logo.png
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/javascripts/spectaql.min.js b/docs/javascripts/spectaql.min.js
diff --git a/docs/stylesheets/spectaql.min.css b/docs/stylesheets/spectaql.min.css
diff --git a/package.json b/package.json
@@ -37,6 +37,7 @@
  "husky": "^8.0.0",
  "jest": "^29.7.0",
  "prettier": "^3.0.3",
+ "spectaql": "^2.3.1",
  "ts-jest": "^29.1.1",
  "ts-node": "^10.9.1",
  "ts-node-dev": "^2.0.0",