Skip to content

Commit 0c89154

Browse files
ShenKSPZShenKSPZ
committed
Update: Update README.md & workflows
1 parent 6915779 commit 0c89154

File tree

4 files changed

+235
-25
lines changed

4 files changed

+235
-25
lines changed

‎.github/workflows/ubuntu.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# This is a basic workflow to help you get started with Actions
2+
name: 'Linux Build'
3+
4+
# Controls when the action will run.
5+
on:
6+
# Triggers the workflow on push or pull request events but only for the main branch
7+
push:
8+
branches:
9+
- main
10+
pull_request:
11+
branches:
12+
- main
13+
14+
# Allows you to run this workflow manually from the Actions tab
15+
workflow_dispatch:
16+
17+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
18+
jobs:
19+
build:
20+
strategy:
21+
matrix:
22+
node-version: [20]
23+
24+
# The type of runner that the job will run on
25+
runs-on: ubuntu-22.04
26+
27+
steps:
28+
- uses: actions/checkout@v3
29+
30+
- name: Cache node modules
31+
uses: actions/cache@v4
32+
env:
33+
cache-name: cache-node-modules
34+
with:
35+
# npm cache files are stored in `~/.npm` on Linux/macOS
36+
path: ~/.npm
37+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
38+
restore-keys: |
39+
${{ runner.os }}-build-${{ env.cache-name }}-
40+
${{ runner.os }}-build-
41+
${{ runner.os }}-
42+
43+
- name: Use Node.js ${{ matrix.node-version }}
44+
uses: actions/setup-node@v3
45+
with:
46+
node-version: ${{ matrix.node-version }}
47+
48+
- name: Install linux dependencies
49+
run: |
50+
sudo apt-get update
51+
sudo apt-get install -y libgtk-3-dev webkit2gtk-4.0 libappindicator3-dev librsvg2-dev patchelf
52+
53+
- name: Install Dependencies
54+
run: npm i
55+
56+
- name: Check lint
57+
run: npm run lint
58+
59+
- name: Build the app
60+
run: npm run electron:build:current_platform

‎.github/workflows/windows.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# This is a basic workflow to help you get started with Actions
2+
name: 'Windows Build'
3+
4+
# Controls when the action will run.
5+
on:
6+
# Triggers the workflow on push or pull request events but only for the main branch
7+
push:
8+
branches:
9+
- main
10+
- dev
11+
pull_request:
12+
branches:
13+
- main
14+
- dev
15+
16+
# Allows you to run this workflow manually from the Actions tab
17+
workflow_dispatch:
18+
19+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
20+
permissions:
21+
contents: read
22+
23+
jobs:
24+
build:
25+
strategy:
26+
matrix:
27+
node-version: [20]
28+
29+
# The type of runner that the job will run on
30+
runs-on: windows-2022
31+
32+
steps:
33+
- uses: actions/checkout@v3
34+
35+
- name: Cache node modules
36+
uses: actions/cache@v4
37+
env:
38+
cache-name: cache-node-modules
39+
with:
40+
# npm cache files are stored in `~/.npm`
41+
path: ~/.npm
42+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
43+
restore-keys: |
44+
${{ runner.os }}-build-${{ env.cache-name }}-
45+
${{ runner.os }}-build-
46+
${{ runner.os }}-
47+
48+
- name: Use Node.js ${{ matrix.node-version }}
49+
uses: actions/setup-node@v3
50+
with:
51+
node-version: ${{ matrix.node-version }}
52+
53+
- name: Install Dependencies
54+
run: npm i
55+
56+
- name: Check lint
57+
run: npm run lint
58+
59+
- name: Build the app
60+
run: npm run electron:build:current_platform

‎README.md

Lines changed: 53 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1+
![TensorBlock Logo Banner](https://img.kookapp.cn/assets/2025-04/11/VWFJZWKDAe1uo0c0.png)
12
# TensorBlock Studio
23

4+
![TensorBlock Studio stars](https://img.shields.io/github/stars/TensorBlock/TensorBlock-Studio)
5+
![TensorBlock Studio forks](https://img.shields.io/github/forks/TensorBlock/TensorBlock-Studio)
6+
37
> A lightweight, open, and extensible multi-LLM interaction studio.
48
> Part of the [TensorBlock](https://tensorblock.co) ecosystem — built to empower anyone to build with AI from anywhere, not just use it.
59
6-
![TensorBlock Studio Banner](https://github.com/TensorBlock/TensorBlock-Studio/blob/dev-production-milestone%231/docs/imgs/TensorBlock%20Studio%20Banner.png?raw=true)
10+
<br>
11+
12+
![TensorBlock Studio Banner](https://img.kookapp.cn/assets/2025-04/11/vUWcjF1fvQ1uo0rr.png)
13+
14+
<br>
715

816
## What Makes TensorBlock Studio Different?
917

1018
Forget generic AI chat tools. **TensorBlock Studio** is a new kind of workspace — one that's lightweight, developer-friendly, and yet welcoming to beginners. It's designed around control, clarity, and creation.
1119

20+
<br>
21+
1222
## Features
1323

1424
- Multiple LLM provider
@@ -18,34 +28,38 @@ Forget generic AI chat tools. **TensorBlock Studio** is a new kind of workspace
1828
- Framer Motion UI transitions
1929
- Local-first data storage for speed and privacy
2030

21-
![TensorBlock Studio Screenshot 01](https://github.com/TensorBlock/TensorBlock-Studio/blob/dev-production-milestone%231/docs/imgs/TensorBlock%20Studio%20Screenshot01.png?raw=true)
31+
<br>
2232

23-
![TensorBlock Studio Screenshot 01](https://github.com/TensorBlock/TensorBlock-Studio/blob/dev-production-milestone%231/docs/imgs/TensorBlock%20Studio%20Screenshot02.png?raw=true)
33+
![TensorBlock Studio Screenshot 01](https://img.kookapp.cn/assets/2025-04/11/JDdzXkmU7b1uo11f.png)
2434

25-
![TensorBlock Studio Screenshot 01](https://github.com/TensorBlock/TensorBlock-Studio/blob/dev-production-milestone%231/docs/imgs/TensorBlock%20Studio%20Screenshot03.png?raw=true)
35+
![TensorBlock Studio Screenshot 01](https://img.kookapp.cn/assets/2025-04/11/DcK9HjWQx71uo11f.png)
2636

27-
---
37+
![TensorBlock Studio Screenshot 01](https://img.kookapp.cn/assets/2025-04/11/o8hDNKQybP1uo11f.png)
2838

29-
# Short-Term Roadmap
39+
<br>
3040

31-
- Sharing and exports
32-
- Collection of knowledge pieces
33-
- Mobile-friendly UI (PWA or native shell)
34-
- Plugin system for extensions and custom logic
35-
- More themes
41+
# 🎯Short-Term Roadmap
3642

37-
# Tech Stack
43+
- [ ] Sharing and exports
44+
- [ ] Collection of knowledge pieces
45+
- [ ] Mobile-friendly UI (PWA or native shell)
46+
- [ ] Plugin system for extensions and custom logic
47+
- [ ] More themes
3848

39-
- Framework: Next.js 14
40-
- UI: Tailwind CSS + ShadCN + Framer Motion
41-
- State: Zustand
42-
- LLM Routing: Custom Forge Layer
49+
<br>
50+
51+
# 🔩Tech Stack
52+
53+
- Framework: Typescript + Node.js 18 + React + Vite + Electron
54+
- UI: Tailwind CSS
55+
- LLM Routing: @ai/sdk
4356
- Storage: IndexedDB / localStorage
4457
- i18n: i18next
4558

46-
---
59+
<br>
4760

48-
# Getting Started
61+
![Getting Started](https://img.kookapp.cn/assets/2025-04/11/BfsbY3Pszp1uo0c0.png)
62+
# ⭐Getting Started
4963

5064
### Installation
5165

@@ -76,7 +90,7 @@ Package the application for your current platform:
7690
npm run electron:build:current_platform
7791
```
7892

79-
---
93+
<br>
8094

8195
# 📄 Documentation
8296

@@ -85,15 +99,29 @@ Comprehensive documentation is available in the `docs` directory:
8599
- [Documentation Index](docs/docs_index.md) - Main documentation entry point with links to all sections
86100
- [Overview](docs/overview.md) - System architecture and high-level application design
87101

88-
---
102+
<br>
103+
104+
# 🤝Contributing
105+
106+
We welcome contributions from the community!
89107

90-
# Contributing
108+
### Contributing Steps
109+
1. Fork the repository
110+
2. Create a feature branch (git checkout -b feature/amazing-feature)
111+
3. Make your changes
112+
4. Run tests to ensure everything works
113+
5. Commit your changes (git commit -m 'Add amazing feature')
114+
6. Push to your branch (git push origin feature/amazing-feature)
115+
7. Open a Pull Request
91116

92-
We're a tiny team (1 designer, 1 frontend, 1 PM) building the tools we wish existed.
93-
Pull requests, bug reports, and feedback are always welcome!
117+
### Development Guidelines
118+
- Follow the code style guide
119+
- Write tests for new features
120+
- Update documentation for any changes
121+
- See CONTRIBUTING.md for detailed guidelines
94122

95-
---
123+
<br>
96124

97-
# License
125+
# 📄License
98126

99127
MIT

‎docs/CHANGELOG.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Changelog
2+
3+
All notable changes to TensorBlock-Studio will be documented in this file.
4+
5+
## [0.0.1.c] - 2025.4.10
6+
7+
### Added
8+
- Multimodal Message Handling implementation
9+
- API Documentation
10+
- Images to README
11+
12+
### Fixed
13+
- Provider Icon Reference issue
14+
- User Message overflow when message is too long
15+
- Select Modal Layout and Collapse Button detection region
16+
- npm run commands updated
17+
- Install instruction update back to npm
18+
19+
### Changed
20+
- Layout and animation polishing to 99% completion
21+
- Layout and animation polishing to 80% completion
22+
23+
## [0.0.1.b] - 2025.4.6
24+
25+
### Added
26+
- Custom models management
27+
- Custom provider creation and deletion functionality
28+
- Folder management system
29+
- Google search functionality
30+
- Web search support
31+
- Switch branch buttons
32+
33+
### Fixed
34+
- Conversation list layout
35+
- Title bar layout issues
36+
- Anthropic provider endpoint connection
37+
- Custom provider update after changes
38+
- Support for custom providers
39+
- Local settings issues
40+
41+
### Upgraded
42+
- Electron builder from v25 to v26
43+
- Migrated to tailwind theming
44+
45+
## [0.0.1.a] - 2025.4.1
46+
47+
### Added
48+
- Chat Branching functionality
49+
- Support for Forge
50+
- Support for all AI providers
51+
- Deep thinking tag recognition
52+
- Streaming message support for Forge
53+
54+
### Fixed
55+
- Branching Message Duplicate Storage issue
56+
- AI Chat Messages regeneration
57+
- Removed duplicate AIProvider
58+
- Temporarily added OpenAI Provider at startup
59+
60+
### Changed
61+
- Completed migration to @ai-sdk library for basic functionality
62+
- Disabled delete message button on UI

0 commit comments

Comments
 (0)