mirror of
https://github.com/ggml-org/llama.cpp.git
synced 2026-07-10 05:00:29 +00:00
59778f0196
* webui: Move static build output from `tools/server/public` to `build/ui` directory * refactor: Move to `tools/ui` * refactor: rename CMake variables and preprocessor defines - Rename LLAMA_BUILD_WEBUI -> LLAMA_BUILD_UI (old kept as deprecated) - Rename LLAMA_USE_PREBUILT_WEBUI -> LLAMA_USE_PREBUILT_UI (old kept as deprecated) - Backward compat: old vars auto-forward to new ones with DEPRECATION warning - Rename internal vars: WEBUI_SOURCE -> UI_SOURCE, WEBUI_SOURCE_DIR -> UI_SOURCE_DIR, etc. - Rename HF bucket: LLAMA_WEBUI_HF_BUCKET -> LLAMA_UI_HF_BUCKET - Emit both LLAMA_BUILD_WEBUI and LLAMA_BUILD_UI preprocessor defines - Emit both LLAMA_WEBUI_DEFAULT_ENABLED and LLAMA_UI_DEFAULT_ENABLED * refactor: rename CLI flags (--webui -> --ui) with backward compat - Add --ui/--no-ui (old --webui/--no-webui kept as deprecated aliases) - Add --ui-config (old --webui-config kept as deprecated alias) - Add --ui-config-file (old --webui-config-file kept as deprecated alias) - Add --ui-mcp-proxy/--no-ui-mcp-proxy (old --webui-mcp-proxy kept as deprecated) - Add new env vars: LLAMA_ARG_UI, LLAMA_ARG_UI_CONFIG, LLAMA_ARG_UI_CONFIG_FILE, LLAMA_ARG_UI_MCP_PROXY - C++ struct fields: params.ui, params.ui_config_json, params.ui_mcp_proxy added alongside old fields - Backward compat: old fields synced to new ones in g_params_to_internals * refactor: update C++ server internals with backward compat - Rename json_webui_settings -> json_ui_settings (both kept in server_context_meta) - Rename params.webui usage -> params.ui (both synced, old still works) - JSON API emits both "ui"/"ui_settings" and "webui"/"webui_settings" keys - Server routes use params.ui_mcp_proxy || params.webui_mcp_proxy - Preprocessor guards use #if defined(LLAMA_BUILD_UI) || defined(LLAMA_BUILD_WEBUI) * refactor: rename CI/CD workflows, artifacts, and build script - Rename webui-build.yml -> ui-build.yml; artifact webui-build -> ui-build - Rename webui-publish.yml -> ui-publish.yml; var HF_BUCKET_WEBUI_STATIC_OUTPUT -> HF_BUCKET_UI_STATIC_OUTPUT - Rename server-webui.yml -> server-ui.yml; job webui-build/checks -> ui-build/checks - Update server.yml: job/artifact refs webui-build -> ui-build - Update release.yml: all webui-build/publish refs -> ui-build/publish; HF_TOKEN_WEBUI_STATIC_OUTPUT -> HF_TOKEN_UI_STATIC_OUTPUT - Update server-self-hosted.yml: webui-build -> ui-build - Update build-self-hosted.yml: HF_WEBUI_VERSION -> HF_UI_VERSION - Rename webui-download.cmake -> ui-download.cmake (internal refs updated) - Update labeler.yml: server/webui -> server/ui path label * docs: update CODEOWNERS and server README docs - Update CODEOWNERS: team ggml-org/llama-webui -> ggml-org/llama-ui, path /tools/server/webui/ -> /tools/ui/ - Update server README.md: CLI tables show --ui flags with deprecated --webui aliases - Update server README-dev.md: "WebUI" -> "UI", paths updated to tools/ui/ * fix: Small fixes for UI build * fix: CMake.txt syntax * chore: Formatting * fix: `.editorconfig` for llama-ui * chore: Formatting * refactor: Use `APP_NAME` in Error route * refactor: Cleanup * refactor: Single migration service * make llama-ui a linkable target * fix: UI Build output * fix: Missing change * fix: separate llama-ui npm build output into build/tools/ui/dist subfolder + use cmake npm build instead of downloading ui-build.yml artifacts in CI * refactor: UI workflows cleanup --------- Co-authored-by: Xuan Son Nguyen <son@huggingface.co>
137 lines
3.6 KiB
TypeScript
137 lines
3.6 KiB
TypeScript
// README Content
|
|
export const README_MD = String.raw`
|
|
# 🚀 Awesome Web Framework
|
|
|
|
[](https://www.npmjs.com/package/awesome-framework)
|
|
[](https://github.com/awesome/framework/actions)
|
|
[](https://codecov.io/gh/awesome/framework)
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
> A modern, fast, and flexible web framework for building scalable applications
|
|
|
|
## ✨ Features
|
|
|
|
- 🎯 **Type-Safe** - Full TypeScript support out of the box
|
|
- ⚡ **Lightning Fast** - Built on Vite for instant HMR
|
|
- 📦 **Zero Config** - Works out of the box for most use cases
|
|
- 🎨 **Flexible** - Unopinionated with sensible defaults
|
|
- 🔧 **Extensible** - Plugin system for custom functionality
|
|
- 📱 **Responsive** - Mobile-first approach
|
|
- 🌍 **i18n Ready** - Built-in internationalization
|
|
- 🔒 **Secure** - Security best practices by default
|
|
|
|
## 📦 Installation
|
|
|
|
${'```'}bash
|
|
npm install awesome-framework
|
|
# or
|
|
yarn add awesome-framework
|
|
# or
|
|
pnpm add awesome-framework
|
|
${'```'}
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Create a new project
|
|
|
|
${'```'}bash
|
|
npx create-awesome-app my-app
|
|
cd my-app
|
|
npm run dev
|
|
${'```'}
|
|
|
|
### Basic Example
|
|
|
|
${'```'}javascript
|
|
import { createApp } from 'awesome-framework';
|
|
|
|
const app = createApp({
|
|
port: 3000,
|
|
middleware: ['cors', 'helmet', 'compression']
|
|
});
|
|
|
|
app.get('/', (req, res) => {
|
|
res.json({ message: 'Hello World!' });
|
|
});
|
|
|
|
app.listen(() => {
|
|
console.log('Server running on http://localhost:3000');
|
|
});
|
|
${'```'}
|
|
|
|
## 📖 Documentation
|
|
|
|
### Core Concepts
|
|
|
|
- [Getting Started](https://docs.awesome.dev/getting-started)
|
|
- [Configuration](https://docs.awesome.dev/configuration)
|
|
- [Routing](https://docs.awesome.dev/routing)
|
|
- [Middleware](https://docs.awesome.dev/middleware)
|
|
- [Database](https://docs.awesome.dev/database)
|
|
- [Authentication](https://docs.awesome.dev/authentication)
|
|
|
|
### Advanced Topics
|
|
|
|
- [Performance Optimization](https://docs.awesome.dev/performance)
|
|
- [Deployment](https://docs.awesome.dev/deployment)
|
|
- [Testing](https://docs.awesome.dev/testing)
|
|
- [Security](https://docs.awesome.dev/security)
|
|
|
|
## 🛠️ Development
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js >= 18
|
|
- pnpm >= 8
|
|
|
|
### Setup
|
|
|
|
${'```'}bash
|
|
git clone https://github.com/awesome/framework.git
|
|
cd framework
|
|
pnpm install
|
|
pnpm dev
|
|
${'```'}
|
|
|
|
### Testing
|
|
|
|
${'```'}bash
|
|
pnpm test # Run unit tests
|
|
pnpm test:e2e # Run end-to-end tests
|
|
pnpm test:watch # Run tests in watch mode
|
|
${'```'}
|
|
|
|
## 🤝 Contributing
|
|
|
|
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
|
|
|
|
### Contributors
|
|
|
|
<a href="https://github.com/awesome/framework/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=awesome/framework" />
|
|
</a>
|
|
|
|
## 📊 Benchmarks
|
|
|
|
| Framework | Requests/sec | Latency (ms) | Memory (MB) |
|
|
|-----------|-------------|--------------|-------------|
|
|
| **Awesome** | **45,230** | **2.1** | **42** |
|
|
| Express | 28,450 | 3.5 | 68 |
|
|
| Fastify | 41,200 | 2.3 | 48 |
|
|
| Koa | 32,100 | 3.1 | 52 |
|
|
|
|
*Benchmarks performed on MacBook Pro M2, Node.js 20.x*
|
|
|
|
## 📝 License
|
|
|
|
MIT © [Awesome Team](https://github.com/awesome)
|
|
|
|
## 🙏 Acknowledgments
|
|
|
|
Special thanks to all our sponsors and contributors who make this project possible.
|
|
|
|
---
|
|
|
|
**[Website](https://awesome.dev)** • **[Documentation](https://docs.awesome.dev)** • **[Discord](https://discord.gg/awesome)** • **[Twitter](https://twitter.com/awesomeframework)**
|
|
`;
|