Omni Chat Backend

Trusted, Extensible, Better Chat

Read about the service here.

To view a specific version's docs, go to https://github.com/neelkamath/omni-chat-backend/tree/<VERSION>, where <VERSION> is the release tag (e.g., v0.1.1).

Here are the guides for running the server using Docker Compose (recommended for local development), and the cloud (recommended for production).

Read these recommendations if you're a developer creating a frontend UI which uses this API.

Here are some notable projects built using the Omni Chat API. If you've built an app, library, etc., create a GitHub issue to have it added to this list.

• (Official) Web app
• (Official) JavaScript API wrapper library

Usage

Note: Operations starting with Query, Mutation, and Subscription (e.g., Query.readChat) are from the GraphQL API. Operations starting with / (e.g., /profile-image) are from the REST API.

• Docs
  • Download the rest-api.html asset from a release. It'll be referenced in the docs.
  • Optionally, generate a wrapper for the GraphQL API using GraphQL Code Generator on schema.graphqls.
  • Optionally, generate a wrapper for the REST API using OpenAPI Generator on openapi.yaml. Note that backwards compatible REST API updates don't guarantee backwards compatible wrappers. For example, a wrapper for REST API v0.3.1 may not be backwards compatible with a wrapper for REST API v0.3.0.
• Changelog
• Branding assets

Contributing

Credits

dockerize was taken from jwilder.

License

This project is under the MIT License.