Skip to content

πŸ‘¨β€πŸ’» Repository

Sebastian MusiaΕ‚ edited this page Mar 18, 2024 · 8 revisions

The repository includes a library with an AI assistant as well as other useful parts:

Name Description More
@boldare/openai-assistant A NestJS library based on the OpenAI Assistant for building efficient, scalable, and quick solutions for AI assistants/chatbots Documentation
@boldare/ai-embedded The code enables embedding the chatbot on various websites through JavaScript scripts. Documentation
api Example usage of the @boldare/openai-assistant library. Documentation
spa Example client application (SPA) with a chatbot. Documenation

Getting started

Step 1: Install dependencies

npm install

Step 2: Env variables

Set up your environment variables, copy the .env.dist file to .env file in the root directory of the project, and populate it with the necessary secrets.

cp .env.dist .env

More details you can find in the assistant AI documentation.

Step 3: Run applications

# Start the app (api and spa)
npm run start:dev

# Start the api
npm run start:api

# Start the spa
npm run start:spa

Now you can open your browser and navigate to:

URL Description
http://localhost:4200/ Client application (Angular)
http://localhost:3000/ API application, WebSockets (socket.io)
http://localhost:3000/api/ API endpoints
http://localhost:3000/api/docs API documentation (swagger)

πŸŽ‰ Happy coding πŸŽ‰