Skip to content

Commit ccd686b

Browse files
Merge pull request #72 from boldare/feat/heroku-deploy-btn
chore: readme update - shields, sections with details
2 parents 8ee6058 + edad8e9 commit ccd686b

File tree

2 files changed

+74
-33
lines changed

2 files changed

+74
-33
lines changed

README.md

+43-33
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,36 @@
1-
<p align="center">
1+
<div align="center" style="text-align: center;">
22
<a href="https://www.boldare.com/services/ai-software-development-consulting/" target="blank">
33
<img src="https://assistant.ai.boldare.dev/assets/ai-assistant.jpg" width="280" alt="Boldare" />
4-
</a>
5-
</p>
4+
</a><br><br>
65

7-
<p align="center">
8-
<a href="https://assistant.ai.boldare.dev/" target="_blank">Demo</a> 🔹
9-
<a href="https://assistant.ai.boldare.dev/api/docs" target="_blank">API docs</a> 🔹
10-
<a href="https://www.npmjs.com/package/@boldare/openai-assistant" target="_blank">npm</a> 🔹
11-
<a href="https://github.com/boldare/openai-assistant" target="_blank">Github</a> 🔹
12-
<a href="https://www.boldare.com/services/ai-software-development-consulting/" target="_blank">How we can help you</a>
13-
</p>
6+
A NestJS library for building efficient, scalable, and fast solutions using the OpenAI Assistant API (chatbots). <br> Kickstart your AI Assistant development in under 15 minutes 🚀
147

8+
<a href="https://assistant.ai.boldare.dev/" target="_blank"><img alt="demo" src="https://img.shields.io/badge/demo-👀-green"></a>&nbsp;
9+
<a href="https://assistant.ai.boldare.dev/api/docs" target="_blank"><img alt="docs" src="https://img.shields.io/badge/api docs-📚-orange"></a>&nbsp;
10+
<a href="https://www.npmjs.com/package/@boldare/openai-assistant" target="_blank"><img alt="npm" src="https://img.shields.io/npm/v/%40boldare%2Fopenai-assistant"></a>&nbsp;
11+
<a href="https://www.boldare.com/services/ai-software-development-consulting/" target="_blank"><img alt="docs" src="https://img.shields.io/badge/How we can help you-💡-brown"></a>&nbsp;
12+
<a href="https://github.com/boldare/openai-assistant" target="_blank"><img alt="Github" src="https://img.shields.io/github/stars/boldare/openai-assistant"></a>
13+
14+
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/boldare/openai-assistant)
1515

16-
# 🤖 AI Assistant
17-
`@boldare/openai-assistant` - library to kickstart your AI Assistant development under 15 minutes.
16+
</div>
17+
18+
# AI Assistant
1819

1920
Introducing the NestJS library. Whether you're building a virtual assistant, or an interactive chatbot for engaging user experiences, our library empowers you to leverage cutting-edge AI capabilities with minimal effort.
2021

2122
**The library provides ready-to-use API endpoints** handling your assistant and WebSocket server for real-time communication between the client and the assistant. Install the library and paste the config to get it running.
2223

2324
## 📚 Watch the tutorial
2425

26+
<div align="center" style="text-align: center;">
27+
2528
[![Watch the tutorial](https://img.youtube.com/vi/rxPdFat90qY/0.jpg)](https://www.youtube.com/watch?v=rxPdFat90qY)
2629

30+
[Video - AI Assistant in 15 min](https://www.youtube.com/watch?v=rxPdFat90qY)
31+
32+
</div>
33+
2734
## 🚀 Features
2835

2936
### AI Assistant library features
@@ -47,9 +54,9 @@ The repository contains a library but also provides additional features. You can
4754

4855
In this section, you will learn how to integrate the AI Assistant library into your NestJS application. The following steps will guide you through the process of setting up the library and creating simple functionalities.
4956

50-
<!-- The information that after this steps we will have the endpoints ready -->
51-
52-
### Step 0: Prerequisites
57+
</details>
58+
<details>
59+
<summary><b>Step 0:</b> Prerequisites</summary><br>
5360

5461
- Node.js (`^20.0.0` version)
5562
- npm (`^10.0.0` version)
@@ -65,7 +72,9 @@ nest new project-name
6572

6673
Now you have to install the packages. Go to the next step.
6774

68-
### Step 1: Installation
75+
</details>
76+
<details>
77+
<summary><b>Step 1:</b> Installation</summary><br>
6978

7079
Make sure you are in the root directory of your project.
7180
Install the library and `openai` package using npm:
@@ -76,7 +85,9 @@ npm i @boldare/openai-assistant openai --save
7685

7786
The library is installed but we have to configure it. Go to the next step.
7887

79-
### Step 2: Env variables
88+
</details>
89+
<details>
90+
<summary><b>Step 2:</b> Env variables</summary><br>
8091

8192
Set up your environment variables, create environment variables in the `.env` file in the root directory of the project, and populate it with the necessary secrets. The assistant ID is optional and serves as a unique identifier for your assistant. When the environment variable is not set, the assistant will be created automatically. You can use the assistant ID to connect to an existing assistant, which can be found in the OpenAI platform after creating an assistant.
8293

@@ -100,7 +111,9 @@ Please note that the `.env` file should not be committed to the repository. *Add
100111

101112
This was the first step needed to run the library. The next step is to configure the assistant.
102113

103-
### Step 3: Configuration
114+
</details>
115+
<details>
116+
<summary><b>Step 3:</b> Configuration</summary><br>
104117

105118
The library provides a way to configure the assistant with the `AssistantModule.forRoot` method. The method takes a configuration object as an argument. Create a new configuration file like in a [sample configuration file (chat.config.ts)](apps%2Fapi%2Fsrc%2Fapp%2Fchat%2Fchat.config.ts) and fill it with the necessary configuration.
106119

@@ -139,7 +152,10 @@ More details about the configuration can be found in the [wiki](https://github.c
139152
From now you can run your application and call the assistant.
140153

141154

142-
### Step 4: Function calling
155+
</details>
156+
<details>
157+
<summary><b>Step 4:</b> Function calling</summary><br>
158+
143159

144160
Function calling allows you to extend the assistant's capabilities with custom logic. **If you are not going to use function calling you can jump to: [Step 5: Testing](#step-5-running-the-application-and-testing).**
145161

@@ -157,7 +173,9 @@ The instructions for creating a function can be found in the [wiki](https://gith
157173
If you've defined a function and the output method, you can now call it from the assistant just by asking him to do the action described in the function definition.
158174

159175

160-
### Step 5: Running the application and testing
176+
</details>
177+
<details>
178+
<summary><b>Step 5:</b> Running the application and testing</summary><br>
161179

162180
Run your application and this will allow you to test the assistant.
163181

@@ -184,24 +202,18 @@ Run your application and this will allow you to test the assistant.
184202

185203
Congrats! You have successfully integrated the AI Assistant library into your NestJS application. 🎉
186204

187-
---
188-
205+
</details>
189206

190207
## 🤔 Are you stuck?
191208

192-
Boldare's engineers are here to help you. If you have any questions or need help with the implementation, feel free to **[click here to book a call with one of our engineers.](https://calendly.com/olivier-halupczok/30min)**
193-
194-
**Learn more how [Boldare can help you with AI development on our website](https://www.boldare.com/services/ai-software-development-consulting/).**
195-
196-
You can also ask questions in the [GitHub Discussions](https://github.com/boldare/openai-assistant/discussions) section.
209+
The complete documentation on how to run the demo with all applications and libraries from the repository can be found in the [wiki](https://github.com/boldare/openai-assistant/wiki/%F0%9F%91%A8%E2%80%8D%F0%9F%92%BB-Repository).
197210

198-
---
211+
Boldare's engineers are here to help you. If you have any questions or need help with the implementation, feel free to [book a call](https://calendly.com/olivier-halupczok/30min) with one of our engineers.
199212

200-
## 👨‍💻 Repository
213+
Learn more how **[Boldare can help you with AI development](https://www.boldare.com/services/ai-software-development-consulting/)**.
201214

202-
The complete documentation on how to run the demo with all applications and libraries from the repository can be found in the [wiki](https://github.com/boldare/openai-assistant/wiki/%F0%9F%91%A8%E2%80%8D%F0%9F%92%BB-Repository).
215+
You can also ask questions in the [GitHub Discussions](https://github.com/boldare/openai-assistant/discussions) section.
203216

204-
---
205217

206218
## Contributions
207219

@@ -210,8 +222,6 @@ Would you like to see new features in the library?
210222
- [Talk your idea over with one of our engineers.](https://calendly.com/olivier-halupczok/30min)
211223
- You can also [post your idea here](https://github.com/boldare/openai-assistant/discussions).
212224

213-
---
214-
215225
## License
216226

217227
`@boldare/openai-assistant` and this repository is MIT licensed

app.json

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "Openai Assistant by Boldare",
3+
"description": "A NestJS project for OpenAI Assistant powered by Boldare",
4+
"repository": "https://github.com/boldare/openai-assistant",
5+
"logo": "https://assistant.ai.boldare.dev/assets/ai-assistant.jpg",
6+
"keywords": ["nestjs", "openai", "assistant", "boldare", "ai", "chatbot", "assistant-ai"],
7+
"env": {
8+
"OPENAI_API_KEY": {
9+
"description": "API key for OpenAI. You can generate and find it in the OpenAI dashboard.",
10+
"required": true
11+
},
12+
"ASSISTANT_ID": {
13+
"description": "Assistant ID has to be defined for Heroku deployment. You can create and find it in the OpenAI dashboard.",
14+
"required": true
15+
},
16+
"APP_URL": {
17+
"description": "URL of your application - required only if you want to embed the chatbot to the different domains",
18+
"required": false
19+
},
20+
"OPENWEATHER_API_KEY": {
21+
"description": "API key for OpenWeather - required only if you want to use weather tool",
22+
"required": false
23+
}
24+
},
25+
"scripts": {},
26+
"formation": {
27+
"web": {
28+
"quantity": 1
29+
}
30+
}
31+
}

0 commit comments

Comments
 (0)