Merge pull request #9 from SJSUCSClub/docs/redoc

added openapi spec
SJSUCSClub · Oct 4, 2024 · dc5b799 · dc5b799
2 parents 7116c81 + ecad645
commit dc5b799
Show file tree

Hide file tree

Showing 4 changed files with 542 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -21,3 +21,16 @@ To shutdown the server and remove associated volume, run:
 ```sh
 docker compose -f docker-compose.dev.yml down -v
 ```
+
+## Documentation
+
+Generate the documentation with:
+
+```sh
+bun run docs
+```
+
+Show Docs
+```sh
+bun run docs:serve
+```
diff --git a/server/.gitignore b/server/.gitignore
@@ -141,4 +141,6 @@ dist
 # SvelteKit build / generate output
 .svelte-kit
 
-# End of https://www.toptal.com/developers/gitignore/api/node
+# End of https://www.toptal.com/developers/gitignore/api/node
+
+docs/index.html