Merge pull request #130 from tcet-opensource/129-setup_APIDOC

TejasNair9977 · web-flow · commit 05572c4e8999 · 2023-06-30T02:00:50.000+05:30
setup APIDOC for auto generating API documentation
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+apidoc
diff --git a/.gitignore b/.gitignore
@@ -129,3 +129,5 @@ dist
 .yarn/install-state.gz
 .pnp.*
 
+# ingore genrated APIdocs
+apidoc
diff --git a/_apidoc.js b/_apidoc.js
@@ -0,0 +1,19 @@
+// ------------------------------------------------------------------------------------------
+// General apiDoc documentation blocks and old history blocks.
+// ------------------------------------------------------------------------------------------
+
+// ------------------------------------------------------------------------------------------
+// Current Success.
+// ------------------------------------------------------------------------------------------
+
+// ------------------------------------------------------------------------------------------
+// Current Errors.
+// ------------------------------------------------------------------------------------------
+
+// ------------------------------------------------------------------------------------------
+// Current Permissions.
+// ------------------------------------------------------------------------------------------
+
+// ------------------------------------------------------------------------------------------
+// History.
+// ------------------------------------------------------------------------------------------
diff --git a/apidoc.json b/apidoc.json
@@ -0,0 +1,5 @@
+{
+    "name": "ERP-backend",
+    "version": "0.1.0",
+    "description": "TCET ERP System is a project that aims to simplify and automate daily operation in TCET."
+  }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
