@khanhromvn/elara-server 1.2.3 → 1.2.5
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.
- package/dist/README.md +67 -0
- package/dist/start.js +135 -137
- package/package.json +2 -2
package/dist/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="./resources/icon.png" width="128" height="128" alt="Elara Logo">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">Elara Server</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<strong>A Powerful, Lightweight AI Backend Proxy & Manager</strong>
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
<p align="center">
|
|
12
|
+
<img src="https://img.shields.io/badge/Node.js-20+-68a063?style=flat-square&logo=node.js" alt="Node.js Version">
|
|
13
|
+
<img src="https://img.shields.io/badge/SQLite-3-003b57?style=flat-square&logo=sqlite" alt="SQLite">
|
|
14
|
+
<img src="https://img.shields.io/badge/License-ISC-blue?style=flat-square" alt="License">
|
|
15
|
+
</p>
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
Elara Server is a lightweight yet powerful backend server that provides a unified API for multiple AI providers (Claude, DeepSeek, Mistral, Groq, Qwen, etc.) while supporting secure local conversation data storage.
|
|
20
|
+
|
|
21
|
+
## ✨ Key Features
|
|
22
|
+
|
|
23
|
+
- 🚀 **Multi-Provider**: Pre-integrated with Claude, DeepSeek, Mistral, Groq, Qwen, and more.
|
|
24
|
+
- 🔌 **Unified API**: A single endpoint for all your AI needs.
|
|
25
|
+
- 💾 **Local Storage**: Automatic SQLite management in `~/.elara-backend/`.
|
|
26
|
+
- ⚡ **Optimized**: Super small footprint (~8MB bundle), starts instantly.
|
|
27
|
+
- 🛠️ **Flexible**: Can be run as a CLI or integrated directly into other Node.js projects.
|
|
28
|
+
|
|
29
|
+
## 🚀 Quick Install
|
|
30
|
+
|
|
31
|
+
Install globally via npm:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm install -g @khanhromvn/elara-server
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## 📖 Usage Guide
|
|
38
|
+
|
|
39
|
+
### Run the Server
|
|
40
|
+
Simply run the following command to start the API server:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
elara-server
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Command Options
|
|
47
|
+
`elara-server` supports custom parameters:
|
|
48
|
+
|
|
49
|
+
- `--port, -p <number>`: Set the server port (default: `8888`).
|
|
50
|
+
- `--db-path <path>`: Specify a custom path for the SQLite database.
|
|
51
|
+
|
|
52
|
+
**Example:**
|
|
53
|
+
```bash
|
|
54
|
+
elara-server --port 9000 --db-path ./my-data.sqlite
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## 📂 Data Storage
|
|
58
|
+
|
|
59
|
+
By default, Elara stores its database and configurations in:
|
|
60
|
+
`~/.elara-backend/database.sqlite`
|
|
61
|
+
|
|
62
|
+
## 📄 License
|
|
63
|
+
|
|
64
|
+
Released under the [ISC](LICENSE) license.
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
<p align="center">Designed by <strong>@khanhromvn</strong></p>
|