-
Notifications
You must be signed in to change notification settings - Fork 43
Enhance README with project overview, architecture, and quickstart guide #24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
tobias-weiss-ai-xr
wants to merge
1
commit into
Euro-Office:main
Choose a base branch
from
tobias-weiss-ai-xr:docs/enhance-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+81
−11
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,23 +4,93 @@ SPDX-License-Identifier: AGPL | |
| --> | ||
|
|
||
| [](https://www.gnu.org/licenses/agpl-3.0.en.html) | ||
| [](https://github.com/Euro-Office/DocumentServer/actions) | ||
|
|
||
| # Euro-Office | ||
| **Your sovereign office** | ||
| # Euro-Office DocumentServer | ||
|
|
||
| [Learn more.](https://github.com/Euro-Office/) | ||
| **Your sovereign office suite** — A free, open-source document editing platform for collaborative editing of documents, spreadsheets, presentations, and PDFs. | ||
|
|
||
| ## Get involved | ||
| Get involved! You can file issues, propose pull requests and more. We are looking forward to make the digital sovereign office space better than ever before! | ||
| ## Quick Start | ||
|
|
||
| ### Try out | ||
| We currently provide a docker image for testing and integration purposes. We are going to publish deb/rpm packages shortly. | ||
| Try it with Docker: | ||
|
|
||
| ``` | ||
| ```sh | ||
| docker pull ghcr.io/euro-office/documentserver:latest | ||
| docker run -i -t -d -p 8080:80 --restart=always -e EXAMPLE_ENABLED=true -e JWT_SECRET=my_jwt_secret ghcr.io/euro-office/documentserver:latest | ||
| docker run -i -t -d -p 8080:80 --restart=always \ | ||
| -e EXAMPLE_ENABLED=true \ | ||
| -e JWT_SECRET=my_jwt_secret \ | ||
| ghcr.io/euro-office/documentserver:latest | ||
| ``` | ||
|
|
||
| Open `http://localhost:8080` to access the editor. | ||
|
|
||
| ## What Is This? | ||
|
|
||
| Euro-Office DocumentServer is the deployment and integration repository for the Euro-Office project. It orchestrates these components into a single deployable service: | ||
|
|
||
| | Component | Repository | Purpose | | ||
| |-----------|-----------|---------| | ||
| | **core** | [Euro-Office/core](https://github.com/Euro-Office/core) | C++ document rendering engine (OOXML, ODF, PDF conversion) | | ||
| | **sdkjs** | [Euro-Office/sdkjs](https://github.com/Euro-Office/sdkjs) | JavaScript SDK for the document editor | | ||
| | **web-apps** | [Euro-Office/web-apps](https://github.com/Euro-Office/web-apps) | HTML/JS UI for document, spreadsheet, and presentation editors | | ||
| | **server** | [Euro-Office/server](https://github.com/Euro-Office/server) | Node.js backend (document service, converter, metrics, admin panel) | | ||
| | **sdkjs-forms** | [Euro-Office/sdkjs-forms](https://github.com/Euro-Office/sdkjs-forms) | Forms plugin for the JavaScript SDK | | ||
| | **core-fonts** | [Euro-Office/core-fonts](https://github.com/Euro-Office/core-fonts) | Font packages for document rendering | | ||
| | **dictionaries** | [Euro-Office/dictionaries](https://github.com/Euro-Office/dictionaries) | Spell-check dictionaries | | ||
|
|
||
| ## Documentation | ||
|
|
||
| - **Build the Docker image**: [build/README.md](build/README.md) | ||
| - **Development environment**: [develop/README.md](develop/README.md) | ||
| - **Contributing guide**: [CONTRIBUTING.md](https://github.com/Euro-Office/.github/blob/main/CONTRIBUTING.md) | ||
| - **Project roadmap**: [ROADMAP.md](https://github.com/Euro-Office/.github/blob/main/ROADMAP.md) | ||
| - **Integration examples**: [document-server-integration](https://github.com/Euro-Office/document-server-integration) | ||
|
|
||
| ## Building from Source | ||
|
|
||
| See [build/README.md](build/README.md) for full instructions. Quick summary: | ||
|
|
||
| ```sh | ||
| git clone --recurse-submodules https://github.com/Euro-Office/DocumentServer.git | ||
| cd DocumentServer/build | ||
| make build-image | ||
| ``` | ||
|
|
||
| For development with live rebuilds, see [develop/README.md](develop/README.md). | ||
|
|
||
| ## Packages | ||
|
|
||
| Debian and RPM packages can be built from the Docker image: | ||
|
|
||
| ```sh | ||
| cd DocumentServer/build | ||
| make packages | ||
| ``` | ||
|
|
||
| Packages are written to `build/deploy/packages/`. See the [build/README.md](build/README.md) for more options including custom versions and Vagrant VM testing. | ||
|
|
||
| ## Running Tests | ||
|
|
||
| ```sh | ||
| cd DocumentServer/build | ||
| docker compose -f develop/docker-compose.yml up -d | ||
| docker compose exec eo bash | ||
| # Run tests from inside the container | ||
| ``` | ||
|
|
||
| ### Building | ||
| ## Get Involved | ||
|
|
||
| - **File issues**: [github.com/Euro-Office/DocumentServer/issues](https://github.com/Euro-Office/DocumentServer/issues) | ||
| - **Submit PRs**: See the [contributing guide](https://github.com/Euro-Office/.github/blob/main/CONTRIBUTING.md) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a good point, we should add general contribution guidelines. |
||
| - **Join the discussion**: Check the [organization profile](https://github.com/Euro-Office) for community channels | ||
|
|
||
| ## License | ||
|
|
||
| Euro-Office is licensed under the [GNU AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html). | ||
|
|
||
| ## Project Links | ||
|
|
||
| Our build steps and processes are documented in https://github.com/Euro-Office/DocumentServer/tree/main/build. For development there are more detailed steps to build and run individual components in https://github.com/Euro-Office/DocumentServer/tree/main/develop | ||
| - **Organization**: [github.com/Euro-Office](https://github.com/Euro-Office) | ||
| - **Roadmap**: [ROADMAP.md](https://github.com/Euro-Office/.github/blob/main/ROADMAP.md) | ||
| - **Contributing**: [CONTRIBUTING.md](https://github.com/Euro-Office/.github/blob/main/CONTRIBUTING.md) | ||
| - **Security**: [SECURITY.md](https://github.com/Euro-Office/.github/blob/main/SECURITY.md) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For now it would be good to keep the link to the organization as the README there gives a bit more background.. Having the summary explanation makes sense, but can you bring back the link?