studylens 0.1.0 → 0.1.1
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/README.md +12 -1
- package/bin/studylens.js +3 -1
- package/package.json +9 -2
package/README.md
CHANGED
|
@@ -15,7 +15,18 @@ AI-powered deep study assistant. Paste notes, upload files, or provide URLs —
|
|
|
15
15
|
- **Granularity control** — limit max knowledge points per ingestion for high-level summaries
|
|
16
16
|
- **Multi-provider LLM** — supports OpenAI-compatible APIs, Ollama, and custom endpoints
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Install
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install -g studylens
|
|
22
|
+
studylens
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Open `http://localhost:3000` — on first launch the Settings panel opens automatically to guide you through LLM setup.
|
|
26
|
+
|
|
27
|
+
Data is stored in `./studylens-data/` in the current directory. Set `STUDYLENS_DATA_DIR` to change the location.
|
|
28
|
+
|
|
29
|
+
## Quick Start (Development)
|
|
19
30
|
|
|
20
31
|
```bash
|
|
21
32
|
npm run setup # Install dependencies (server + portal)
|
package/bin/studylens.js
CHANGED
|
@@ -2,4 +2,6 @@
|
|
|
2
2
|
const path = require('path');
|
|
3
3
|
const dataDir = process.env.STUDYLENS_DATA_DIR || path.join(process.cwd(), 'studylens-data');
|
|
4
4
|
process.env.STUDYLENS_WIKI_DIR = process.env.STUDYLENS_WIKI_DIR || dataDir;
|
|
5
|
-
require('../server/index.js');
|
|
5
|
+
const app = require('../server/index.js');
|
|
6
|
+
const PORT = process.env.PORT || 3000;
|
|
7
|
+
app.listen(PORT, () => console.log(`StudyLens server running on http://localhost:${PORT}`));
|
package/package.json
CHANGED
|
@@ -1,13 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "studylens",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "AI-powered deep study assistant — turn notes into structured knowledge",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
8
|
"url": "https://github.com/cdlliuy/studygraph.git"
|
|
9
9
|
},
|
|
10
|
-
"keywords": [
|
|
10
|
+
"keywords": [
|
|
11
|
+
"study",
|
|
12
|
+
"learning",
|
|
13
|
+
"llm",
|
|
14
|
+
"ai",
|
|
15
|
+
"education",
|
|
16
|
+
"knowledge"
|
|
17
|
+
],
|
|
11
18
|
"main": "server/index.js",
|
|
12
19
|
"bin": {
|
|
13
20
|
"studylens": "./bin/studylens.js"
|