Added swagger and updated the readme with bun related commands

README.md

@@ -14,6 +14,8 @@ This project is an open-source alternative to OpenAI's Assistant API. It provide
 
 To get a local copy up and running, follow these steps:
 
+Sprout uses [Bun](https://bun.sh/) as its JavaScript runtime environment, replacing Node.js. Please ensure Bun is installed before you proceed. Additionally, Sprout employs [Elysia](https://elysiajs.com) as its web framework for constructing the backend server.
+
 1. Clone the repository
 
 ```
@@ -23,16 +25,20 @@ git clone https://github.com/guibibeau/sprout.git
 2. Install the dependencies
 
 ```
-npm install
+bun install
 
 ```
 
-3. Start the server
+3. Start Elysia in development mode with auto-reload on code change
 
 ```
-npm start
+bun run dev
 ```
 
+4. Access endpoint documentation
+
+Access `/swagger` to view the endpoint documentation 
+
 ## Contributing
 
 Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

package.json

@@ -10,6 +10,7 @@
   },
   "dependencies": {
     "@elysiajs/bearer": "^0.7.0",
+    "@elysiajs/swagger": "^0.8.5",
     "elysia": "latest",
     "ioredis": "^5.3.2",
     "jsonwebtoken": "8.5.1",

src/index.ts

@@ -1,5 +1,6 @@
 import { Elysia } from "elysia";
 import { bearer } from "@elysiajs/bearer";
+import { swagger } from "@elysiajs/swagger";
 
 import { threads } from "@/core/application/controllers/thread/threadController";
 import { assistants } from "@/core/application/controllers/assistant/assistantController";
@@ -18,6 +19,7 @@ export const healthCheck = async () => {
 };
 
 export const app = new Elysia()
+  .use(swagger())
   .use(bearer())
   .use(assistants)
   .use(threads)