diff --git a/.gitignore b/.gitignore index a5c0992..9696946 100644 --- a/.gitignore +++ b/.gitignore @@ -130,4 +130,5 @@ yarn.lock package-lock.json build -*.sqlite \ No newline at end of file +*.sqlite +docs diff --git a/README.md b/README.md index d667e4b..0898503 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,11 @@ Backend Server yarn dev ``` +### Generate Docs +``` +yarn docs +``` + ### Docker w/ postgres 🐳 ```bash diff --git a/package.json b/package.json index 257c22d..335f5ce 100644 --- a/package.json +++ b/package.json @@ -53,10 +53,12 @@ "nodemon": "^2.0.6", "sqlite3": "^5.0.0", "ts-node": "^9.0.0", + "typedoc": "^0.19.2", "typescript": "^4.1.2" }, "scripts": { "dev": "nodemon src/app.ts", - "build": "tsc" + "build": "tsc", + "docs": "typedoc --out docs src" } -} \ No newline at end of file +}