Skip to content
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

WIP: Remove inexisting and outdated content #1646

Merged
merged 3 commits into from
Jan 14, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 26 additions & 82 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">
<a href="https://getmesh.io">
<img src="https://getmesh.io/assets/gentics-mesh-logo.png" width="420" alt="Gentics Mesh" />
<a href="https://gentics.com/mesh">
<img src="https://www.gentics.com/mesh/assets/gentics-mesh-logo.png" width="420" alt="Gentics Mesh" />
</a>
</h1>

Expand Down Expand Up @@ -39,15 +39,9 @@ successfully in less time, no matter which technology you prefer.

<br />

<p align="center">
<a href="https://getmesh.io/">
<img src="https://getmesh.io/assets/mesh-heroimg.png" alt="Gentics Mesh Screenshot" style="max-width: 80%" />
</a>
</p>

# Quick Start

Check out our [Getting Started Guide](https://getmesh.io/docs/getting-started/)
Check out our [Getting Started Guide](https://www.gentics.com/mesh/docs/getting-started/)
for an explanation of the basic concepts of Gentics Mesh.

# Table of Contents
Expand Down Expand Up @@ -107,11 +101,6 @@ external applications which handle the content delivery to the client, meaning
that the content can be (re-)used by multiple applications and channels (web,
mobile app, audio guides, IOT).

<p align="center">
<img src="https://getmesh.io/blog/gentics-mesh-1-0/headless-vs-coupled.png" alt="a coupled vs a headless CMS" style="max-width: 80%" />
</p>


## Why pick Gentics Mesh?

Gentics Mesh is the platform that holds your content, gives you great APIs to
Expand All @@ -131,19 +120,14 @@ What makes Gentics Mesh special over other headless CMSes is:
* it thinks in content trees (just like websites do), which brings you many
things for free: automatic navigation menus, automatic beautiful URLs,
built-in link resolving, …​
* it is scalable and built for clustering, so your deployment can grow with
* it is scalable and clustering-friendly, so your deployment can grow with
your project’s success.


# Status

Gentics Mesh is actively developed by a dedicated team at Gentics Software GmbH in Vienna,
Austria.

<p align="center">
<img src="https://getmesh.io/blog/JPGs/CMP-DEV.jpg" alt="CMP DEV" style="max-width: 80%" />
</p>

The Gentics Mesh core team consists of the following members:

<p align="center">
Expand Down Expand Up @@ -180,39 +164,6 @@ The Gentics Mesh core team consists of the following members:
Serhii Plyhun<br /><i>Backend developer</i>
</a>
</td>
</tr>
</tr>
</tr>
<tr>
<td align="center">
<a href="https://github.com/guggi">
<!-- <img src="https://avatars.githubusercontent.com/pschulzk?size=150" width="150" /><br /> -->
Oliver Guggenberger<br /><i>Backend developer</i>
</a>
</td>
</tr>
</tr>
</tr>
</tr>
<tr>
<td align="center">
<a href="https://github.com/netwarex">
<!-- <img src="https://avatars.githubusercontent.com/pschulzk?size=150" width="150" /><br /> -->
Péter Nyári<br /><i>Frontend developer</i>
</a>
</td>
</tr>
</tr>
</tr>
</tr>
</tr>
<tr>
<td align="center">
<a href="https://github.com/enizhou">
<!-- <img src="https://avatars.githubusercontent.com/pschulzk?size=150" width="150" /><br /> -->
En Qiang Zhou<br /><i>Product Owner</i>
</a>
</td>
</tr>
</table>
</p>
Expand All @@ -225,29 +176,29 @@ For your first steps, please refer to the [Quick Start](#quick-start) which
shows you how to run the demo application.

When you're ready to run your own CMS installation, check out our
[Administration Guide](https://getmesh.io/docs/administration-guide/) where you
[Administration Guide](https://www.gentics.com/mesh/docs/administration-guide/) where you
will find everything you need to know, and much more.


# Features

* [GraphQL API](https://getmesh.io/docs/graphql/)
* [content events via websocket](https://getmesh.io/docs/events/)
* [user, role and permission management](https://getmesh.io/docs/features/#_permissions)
* [document-level permissions](https://getmesh.io/docs/features/#_permissions)
* [versioned content](https://getmesh.io/docs/features/#versioning)
* [a webroot API for easy integration with modern routing frameworks](https://getmesh.io/docs/features/#webroot)
* [a search API powered by Elasticsearch](https://getmesh.io/docs/elasticsearch/)
* [an image manipulation API](https://getmesh.io/docs/features/#imagemanipulation)
* [a tagging API](https://getmesh.io/docs/building-blocks/#_tag)
* [clustering support](https://getmesh.io/docs/clustering/)
* [monitoring support](https://getmesh.io/docs/monitoring/)
* [GraphQL API](https://www.gentics.com/mesh/docs/graphql/)
* [content events via websocket](https://www.gentics.com/mesh/docs/events/)
* [user, role and permission management](https://www.gentics.com/mesh/docs/features/#_permissions)
* [document-level permissions](https://www.gentics.com/mesh/docs/features/#_permissions)
* [versioned content](https://www.gentics.com/mesh/docs/features/#versioning)
* [a webroot API for easy integration with modern routing frameworks](https://www.gentics.com/mesh/docs/features/#webroot)
* [a search API powered by Elasticsearch](https://www.gentics.com/mesh/docs/elasticsearch/)
* [an image manipulation API](https://www.gentics.com/mesh/docs/features/#imagemanipulation)
* [a tagging API](https://www.gentics.com/mesh/docs/building-blocks/#_tag)
* [clustering support](https://www.gentics.com/mesh/docs/clustering/)
* [monitoring support](https://www.gentics.com/mesh/docs/monitoring/)
* an embedded graph database at its core
* support for [Docker](https://getmesh.io/docs/deployment/#_docker)
* support for [Docker](https://www.gentics.com/mesh/docs/deployment/#_docker)

# Documentation

You can find our extensive documentation at https://getmesh.io/docs/
You can find our extensive documentation at https://www.gentics.com/mesh/docs/

# Getting Help

Expand Down Expand Up @@ -305,17 +256,14 @@ authenticate using basic auth.

## Using the REST API

Some sample API requests:

* List users [/users](https://demo.getmesh.io/api/v2/users)
* List nodes [/demo/nodes?perPage=5](https://demo.getmesh.io/api/v2/demo/nodes?perPage=5)
* Load by path [/demo/webroot/yachts/indian-empress](https://demo.getmesh.io/api/v2/demo/webroot/yachts/indian-empress)
* Load Image [/demo/webroot/images/yacht-pelorus.jpg?w=700](https://demo.getmesh.io/api/v2/demo/webroot/images/yacht-pelorus.jpg?w=700)

The full REST API documentation is available at the [Gentics Infoportal](https://www.gentics.com/mesh/docs/api/#).

## Using the GraphQL API

[A sample GraphQL query](https://demo.getmesh.io/api/v2/demo/graphql/browser/#query=query%20webroot(%24path%3A%20String)%20%7B%0A%20%20node(path%3A%20%24path)%20%7B%0A%20%20%20%20...%20on%20vehicle%20%7B%0A%20%20%20%20%20%20fields%20%7B%0A%20%20%20%20%20%20%20%20name%0A%20%20%20%20%20%20%20%20description%0A%20%20%20%20%20%20%20%20vehicleImage%20%7B%0A%20%20%20%20%20%20%20%20%20%20uuid%0A%20%20%20%20%20%20%20%20%20%20path%0A%20%20%20%20%20%20%20%20%20%20...%20on%20vehicleImage%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20fields%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20image%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20height%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20width%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20dominantColor%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D%0A&variables=%7B%22path%22%3A%20%22%2Fyachts%2Fpelorus%22%7D)
The data fetching [GraphQL API](https://www.gentics.com/mesh/docs/api/#project__graphql__post) is a part of the public REST API.
The `IntrospectionQuery` is supported as well, so one can use a REST API tool with GraphQL support to have a code-assisted experience while writing own GraphQL queries.

An example of a GraphQL query looks as follows:

```
query webroot($path: String) {
Expand Down Expand Up @@ -349,18 +297,14 @@ query webroot($path: String) {

# Contributing to Gentics Mesh

Please read our [Contributing Guidelines](https://getmesh.io/docs/contributing/) if you intend to contribute to the project. The guidelines will tell you the
Please read our [Contributing Guidelines](https://www.gentics.com/mesh/docs/contributing/) if you intend to contribute to the project. The guidelines will tell you the
legal information, give you instructions on how to set up your IDE in order to build Gentics Mesh, and will tell you necessary knowledge to understand the codebase.

Gentics Mesh is currently split into two repositories:

* https://github.com/gentics/mesh contains the backend code
* https://github.com/gentics/mesh-ui contains the frontend code

* https://github.com/gentics/mesh contains the Gentics Mesh code

# Copyright & License

Copyright (c) 2014-2023 Gentics Software GmbH. Licensed under the
Copyright (c) 2014-2025 Gentics Software GmbH. Licensed under the
Apache License, Version 2.0.

Gentics is a registered trade mark of Gentics Software GmbH.