From e4cb253913bb54af17e5ef18574a566a207e2647 Mon Sep 17 00:00:00 2001 From: Kseniya Fedoruk Date: Fri, 23 Jan 2026 12:54:03 +0300 Subject: [PATCH] Update README.md --- Readme.md | 91 ++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 77 insertions(+), 14 deletions(-) diff --git a/Readme.md b/Readme.md index 1c936b3db8..4a275ec158 100644 --- a/Readme.md +++ b/Readme.md @@ -1,27 +1,90 @@ [![License](https://img.shields.io/badge/License-GNU%20AGPL%20V3-green.svg?style=flat)](https://www.gnu.org/licenses/agpl-3.0.en.html) -## web-apps +

ONLYOFFICE web-apps

-The frontend for [ONLYOFFICE Document Server][2] and [ONLYOFFICE Desktop Editors](https://github.com/ONLYOFFICE/DesktopEditors). Builds the program interface and allows the user create, edit, save and export text documents, spreadsheets, and presentations. +## πŸ’‘ Overview -## Previous versions +Welcome to the `web-apps` repository! -Until 2019-10-23 the repository was called web-apps-pro. +It’s the frontend for [ONLYOFFICE Document Server](https://github.com/ONLYOFFICE/DocumentServer) and [ONLYOFFICE Desktop Editors](https://github.com/ONLYOFFICE/DesktopEditors) β€” the part you interact with. It powers the interface that lets you create, edit, save, and export your text documents, spreadsheets, and presentations. -## Project information +*Previous versions: Until 2019-10-23 the repository was called web-apps-pro.* -Official website: [https://www.onlyoffice.com/](https://www.onlyoffice.com "https://www.onlyoffice.com") +--- -Code repository: [https://github.com/ONLYOFFICE/web-apps](https://github.com/ONLYOFFICE/web-apps "https://github.com/ONLYOFFICE/web-apps") +## βš™οΈ How it fits in the ONLYOFFICE ecosystem -## User feedback and support -If you have any problems with or questions about [ONLYOFFICE Document Server][2], please visit our official forum: [forum.onlyoffice.com][1] or you can ask and answer ONLYOFFICE development questions on [Stack Overflow][3]. +| Layer | Component | Role | +|-----------|------------|------| +| 🧠 **Engine** | [Document Server β†—](https://github.com/ONLYOFFICE/DocumentServer) | Handles editing logic, file conversion, real-time collaboration | +| πŸ’» **Interface** | **Web Apps** *(this repo)* | Provides the browser-based user interface | +| 🧩 **Integrations** | [Integration API β†—](https://api.onlyoffice.com/docs/docs-api/get-started/basic-concepts/?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) | Embeds editors into custom web platforms or apps | - [1]: https://forum.onlyoffice.com - [2]: https://github.com/ONLYOFFICE/DocumentServer - [3]: http://stackoverflow.com/questions/tagged/onlyoffice +Together, these layers make **ONLYOFFICE** a full-fledged online editing suite. -## License +--- -web-apps is released under an GNU AGPL v3.0 license. See the LICENSE file for more information. +## πŸš€ Key highlights + +✨ **Multiple editors, one codebase** +- [Document Editor](https://www.onlyoffice.com/word-processor?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) πŸ“ +- [Spreadsheet Editor](https://www.onlyoffice.com/sheets?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) πŸ“Š +- [Presentation Editor](https://www.onlyoffice.com/slides?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) πŸ“½οΈ +- [PDF Editor](https://www.onlyoffice.com/pdf-editor?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) βœ‚οΈ +- [Form Creator](https://www.onlyoffice.com/form-creator?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) πŸ“ +- [Diagram Viewer](https://www.onlyoffice.com/diagram-viewer?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) πŸ–ΌοΈ + +πŸ’¬ **Real-time collaboration** +- Co-editing +- Comments, mentions, and version history +- Built-in chat and track changes + +⚑ **Developer-friendly integration** +- Embed editors in any app using [ONLYOFFICE API β†—](https://api.onlyoffice.com/docs/docs-api/get-started/basic-concepts/?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) +- Customize toolbar, permissions, and callback behavior + +🌍 **Fully browser-compatible** +- Works on all major browsers +- Localized in 45 languages +- Optimized for responsive performance + +--- + +## 🧱 Folder overview + +Here’s a quick tour of what lives inside this repository: + +| Folder | Description | +|--------|--------------| +| `.github/workflows/` | GitHub Action workflows for CI, build validation, testing, and checks. | +| `.vscode/` | Editor configuration for VS Code.| +| `apps/` | Core UI for the three editors (Documents, Spreadsheets, Presentations). This is where the frontend interface lives. | +| `build/` | Build scripts, bundling configuration, and output settings for packaging the web editors. | +| `test/` | Test suites and scripts used to validate functionality and stability. | +| `translation/` | All localization files and translations. | +| `vendor/` | Third-party libraries and dependencies used by the editors. | + + +## πŸ”§ Want to build this yourself? + +If you’d like to compile or modify the editors yourself, use the [`build_tools`](https://github.com/ONLYOFFICE/build_tools) repository. + +It automatically sets up dependencies and builds: + +* [Docs (Document Server)](https://www.onlyoffice.com/docs?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) +* [Desktop Editors](https://www.onlyoffice.com/desktop?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) +* [Document Builder](https://www.onlyoffice.com/document-builder?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps) + +## Need help or have an idea? πŸ’‘ + +We ❀️ community contributions! + +* **🐞 Found a bug?** Please report it by creating an [issue](https://github.com/ONLYOFFICE/web-apps/issues). +* **❓ Have a question?** Ask our community and developers on the [ONLYOFFICE Forum](https://community.onlyoffice.com). +* **πŸ’‘ Want to suggest a feature?** Share your ideas on our [feedback platform](https://feedback.onlyoffice.com/forums/966080-your-voice-matters). +* **πŸ§‘β€πŸ’» Need help for developers?** Check our [API documentation](https://api.onlyoffice.com/?utm_source=github&utm_medium=cpc&utm_campaign=GitHubWebApps). + +--- + +

Made with ❀️ by the ONLYOFFICE Team

\ No newline at end of file