685e1a64e9
Signed-off-by: Pedro Pinto Silva <pedro.silva@collabora.com> Change-Id: I95029916bda70206654eeadfc69180490f8ee532
85 lines
5.7 KiB
Markdown
85 lines
5.7 KiB
Markdown
[![Build Status](https://cpci.cbg.collabora.co.uk:8080/view/Gerrit/job/Gerrit%20for%20core%20%28co-2021%29%20side%20of%20online%20master/badge/icon?subject=Gerrit%20core%20co-2021)](https://cpci.cbg.collabora.co.uk:8080/view/Gerrit/job/Gerrit%20for%20core%20%28co-2021%29%20side%20of%20online%20master/) [![Build Status](https://cpci.cbg.collabora.co.uk:8080/view/Gerrit/job/Gerrit%20for%20core%20(co-22.05)%20side%20of%20online%20master/badge/icon?subject=Gerrit%20core%20co-22.05)](https://cpci.cbg.collabora.co.uk:8080/view/Gerrit/job/Gerrit%20for%20core%20(co-22.05)%20side%20of%20online%20master/)
|
||
|
||
[![Build Status](https://cpci.cbg.collabora.co.uk:8080/view/Gerrit/job/Tinderbox%20for%20online%20master%20against%20co-2021/badge/icon?subject=master%20vs%20co-2021)](https://cpci.cbg.collabora.co.uk:8080/view/Gerrit/job/Tinderbox%20for%20online%20master%20against%20co-2021/) [![Build Status](https://cpci.cbg.collabora.co.uk:8080/view/Gerrit/job/Tinderbox%20for%20online%20master%20against%20co-22.05/badge/icon?subject=master%20vs%20co-22.05)](https://cpci.cbg.collabora.co.uk:8080/view/Gerrit/job/Tinderbox%20for%20online%20master%20against%20co-22.05/)
|
||
|
||
<p align="right"><a href="#gitpod"><img alt="Open in Gitpod" src="https://gitpod.io/button/open-in-gitpod.svg"></a></p>
|
||
|
||
# Collabora Online
|
||
<!--
|
||
[![Master: Pull request policy](https://img.shields.io/badge/Master-PRs%20can%20be%20merge%20without%20approval-42BC00?logoColor=42BC00&logo=git "Main release is still distant. Thanks for your support and contributions! :)")](https://github.com/CollaboraOnline/online/blob/master/CONTRIBUTING.md#contributing-to-source-code)
|
||
-->
|
||
[![Master: Pull request policy](https://img.shields.io/badge/Master-protected%2C%20PRs%20need%20approval-red?logoColor=lightred&logo=git "Collabora Team is preparing for the next release, therefore 'master' branch is protected now, PRs need 1 review before merging. Thanks for your support and contributions! :)")](https://github.com/CollaboraOnline/online/blob/master/CONTRIBUTING.md#contributing-to-source-code)
|
||
|
||
|
||
[![irc](https://img.shields.io/badge/IRC-%23cool--dev%20on%20libera-orange.svg)](https://web.libera.chat/?channels=cool-dev)
|
||
[![Telegram](https://img.shields.io/badge/Telegram-Collabora%20Online-green.svg)](https://t.me/CollaboraOnline)
|
||
[![Forum](https://img.shields.io/badge/Forum-Discourse-blue.svg)](https://forum.collaboraonline.com/)
|
||
[![Website](https://img.shields.io/badge/Website-collaboraonline.github.io-blueviolet.svg)](https://collaboraonline.github.io/)
|
||
[![L10n](https://img.shields.io/badge/L10n-Weblate-lightgrey.svg)](https://hosted.weblate.org/projects/collabora-online/)
|
||
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/CollaboraOnline/online)
|
||
|
||
|
||
**LibreOffice in the Cloud on your own Terms**
|
||
|
||
![](https://raw.githubusercontent.com/CollaboraOnline/CollaboraOnline.github.io/source/static/images/homepage-image.jpg)
|
||
|
||
## Key features
|
||
* View and edit text documents, spreadsheets, presentations & more
|
||
* Collaborative editing features
|
||
* Works in any modern browser – no plugin needed
|
||
* Open Source – primarily under the [MPLv2](http://mozilla.org/MPL/2.0/) license. Some parts are under other open source licences, see e.g. [browser/LICENSE](https://github.com/CollaboraOnline/online/blob/master/browser/LICENSE).
|
||
|
||
## Website
|
||
|
||
For many more details, build instructions, downloads and more please visit https://collaboraonline.github.io/
|
||
|
||
## Developer assistance
|
||
Please ask your questions on `irc.libera.chat` in our `#cool-dev` channel
|
||
|
||
Join the conversation on our Discourse server at https://forum.collaboraonline.com/
|
||
|
||
Watch the tinderbox status (if it's green) at
|
||
https://cpci.cbg.collabora.co.uk:8080/view/Tinderbox/job/Tinderbox%20for%20online%20master/
|
||
|
||
## Development bits
|
||
|
||
This project has several components:
|
||
* **wsd/**
|
||
* The Web Services Daemon - which accepts external connections
|
||
* **kit/**
|
||
* The client which lives in its own chroot and renders documents
|
||
* **common/**
|
||
* Shared code between these processes
|
||
* **browser/**
|
||
* The client side JavaScript component
|
||
* **test/**
|
||
* C++ based unit tests
|
||
* **cypress_test/**
|
||
* JavaScript based integration tests
|
||
|
||
## Further recommended reading with build details
|
||
|
||
Please consult the README files in the component's directory for more details:
|
||
- wsd/README
|
||
- browser/README
|
||
|
||
## iOS and Android apps
|
||
|
||
See the corresponding READMEs:
|
||
* **ios/README**
|
||
* **android/README**
|
||
|
||
## GitPod
|
||
|
||
Head over to https://collaboraonline.github.io/post/build-code/ select gitpod from the dropdown and follow the steps.
|
||
|
||
Interesting things to keep in mind:
|
||
- Make sure your browser is not blocking windows/tabs from opening from the gitpod workspace URL (maybe add `*.gitpod.io` to your browser's whitelist)
|
||
- The GitPod tasks will run automatically and further instructions will be printed out right in the terminal
|
||
- VNC tab will open automatically if not just click in the left icon `Remote explorer` and click `6080`. You will see a tab completly black, that's normal.
|
||
- As mentioned in those instructions if you are not using the VS Code desktop and if you are only relying on your browser please:
|
||
- Do not try to click the URL from the make run out put instead copy that URL and execute `firefox [paste URL here]`
|
||
- Head over to the tab where the VNC is opened (black page), you will see Firefox opening there, maximize and have fun.
|
||
- You can also run cypress tests via GitPod but you will need to use Firefox, for that just prepend `CYPRESS_BROWSER="firefox"` to the desired command. Example: `CYPRESS_BROWSER="firefox" make check` for every test or `CYPRESS_BROWSER="firefox" make check-desktop spec=impress/scrolling_spec.js` for one specific test on desktop
|
||
|
||
## Enjoy!
|