athena-xai-chat 1.0.59

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +88 -0
  2. package/package.json +24 -0
package/README.md ADDED
@@ -0,0 +1,88 @@
1
+ <br />
2
+ <div align="center">
3
+ <a href="https://a-x.ai/" style="text-decoration: none; color: white !important; padding-top: 20px; font-size: 88px !important;">
4
+ <img src="https://a-x.ai/wp-content/uploads/2024/04/athena-xai-ico.svg" alt="Logo" width="145" style="padding-right: 15px;">
5
+ <h1>ATHENA XAI</h1>
6
+ </a>
7
+
8
+ <h1 align="center" style="color: white;">Chat</h1>
9
+ </div>
10
+
11
+ <br />
12
+ <details>
13
+ <summary>Table of Contents</summary>
14
+ <ol>
15
+ <li>
16
+ <a href="#about-the-project">About The Project</a>
17
+ <ul>
18
+ <li><a href="#built-with">Built With</a></li>
19
+ </ul>
20
+ </li>
21
+ <li>
22
+ <a href="#getting-started">Getting Started</a>
23
+ <ul>
24
+ <li><a href="#prerequisites">Prerequisites</a></li>
25
+ <li><a href="#installation">Installation</a></li>
26
+ </ul>
27
+ </li>
28
+ <li><a href="#usage">Usage</a></li>
29
+ <li><a href="#contributing">Contributing</a></li>
30
+ <li><a href="#documentation">Documentation</a></li>
31
+ </ol>
32
+ </details>
33
+
34
+ ## About The Project
35
+
36
+ The general idea is to build a custom script to implement Athena XAI Chat.
37
+
38
+ Main features:
39
+ * Select chat
40
+ * Free chat
41
+
42
+ ### Built With
43
+
44
+ * Programing language: [Typescript](https://www.typescriptlang.org/)
45
+ * Package Manager: [npm](https://www.npmjs.com/)
46
+ * Compiler: [Vite](https://vite.dev/)
47
+
48
+ ## Getting Started
49
+
50
+ Follow the next sections to learn how to install and use the script.
51
+
52
+ ## Requirements
53
+
54
+ 1. Node.js version >= 22.12.0
55
+
56
+ ## Usage/Examples
57
+
58
+ ```
59
+ <!DOCTYPE html>
60
+ <html lang="en">
61
+ <head>
62
+ <meta charset="UTF-8" />
63
+ <link rel="icon" type="image/svg+xml" href="#" />
64
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
65
+ <title>Athena XAI Chat</title>
66
+
67
+ <script type="module" src="/src/athena-xai-chat.ts"></script>
68
+
69
+ <style>
70
+ * {
71
+ padding: 0;
72
+ margin: 0;
73
+ box-sizing: border-box;
74
+ }
75
+
76
+ body {
77
+ height: 100dvh;
78
+ }
79
+ </style>
80
+ </head>
81
+ <body>
82
+ <athena-xai-chat websiteToken="website token from the dashboard"></athena-xai-chat>
83
+ </body>
84
+ </html>
85
+ ```
86
+
87
+
88
+ <p align="right">(<a href="#about-the-project">back to top</a>)</p>
package/package.json ADDED
@@ -0,0 +1,24 @@
1
+ {
2
+ "name": "athena-xai-chat",
3
+ "private": false,
4
+ "files": [
5
+ "dist"
6
+ ],
7
+ "version": "1.0.59",
8
+ "type": "module",
9
+ "scripts": {
10
+ "dev": "vite",
11
+ "build": "tsc && vite build",
12
+ "preview": "vite preview"
13
+ },
14
+ "dependencies": {
15
+ "dompurify": "^3.3.0",
16
+ "lit": "^3.3.1",
17
+ "swiper": "^12.0.3"
18
+ },
19
+ "devDependencies": {
20
+ "@types/node": "^24.7.1",
21
+ "typescript": "~5.9.3",
22
+ "vite": "^7.1.7"
23
+ }
24
+ }