# Logux

> Logux is a flexible JS framework to make local-first sync engine with real-time updates, offline-first, CRDT, an optimistic UI.

Every page has a Markdown twin: add `.md` to the page URL, or ask for the page itself with `Accept: text/markdown`.

## Guide

- [Logux](https://logux.org/index.md): Overview of Logux with client and server examples.
- [Creating New Logux Project](https://logux.org/guide/starting/project.md): Logux is a flexible framework.
- [Starting Logux Server Project](https://logux.org/guide/starting/server.md): The simple Logux server is ready.
- [Starting Logux Client Project](https://logux.org/guide/starting/client.md): In this section, we will create a UI client for Logux with Logux Client.
- [Core Concepts of Logux](https://logux.org/guide/architecture/core.md): Logux synchronizes action log between peer-to-peer nodes.
- [Using Logux Concepts in Practice](https://logux.org/guide/architecture/practice.md): Logux architecture was designed to be peer-to-peer and flexible.
- [What Problems does Logux Solve](https://logux.org/guide/architecture/solved.md): We created Logux to have better UX in non-stable networks of the real world.
- [Comparing Logux with AJAX and GraphQL](https://logux.org/guide/architecture/compare.md): All three technologies (Logux, AJAX, GraphQL) was created for communication between clients and server.
- [Logux Parts](https://logux.org/guide/architecture/parts.md): We split Logux into many projects.
- [Nodes](https://logux.org/guide/concepts/node.md): Logux uses the peer-to-peer model.
- [Actions](https://logux.org/guide/concepts/action.md): Logux actions are very similar to Redux actions.
- [Meta](https://logux.org/guide/concepts/meta.md): Meta contains Logux-related data.
- [Application State](https://logux.org/guide/concepts/state.md): The state describes all data of your application.
- [Channels and Subscriptions](https://logux.org/guide/concepts/subscription.md): Since Logux is a real-time system, subscriptions and channels are the main way to get data from the server.
- [Cleaning Log and Action Reasons](https://logux.org/guide/concepts/reason.md): Logux uses reasons API for it to clean log from outdated actions.
- [Subprotocols](https://logux.org/guide/concepts/subprotocol.md): Deploying a SPA is not easy.

## Recipes

- [Authentication with Logux](https://logux.org/recipes/authentication.md): In this example, we will use simple email/password authentication.
- [Using Logux with TypeScript](https://logux.org/recipes/typescript.md): Logux has built-in TypeScript support.
- [Writing Tests for Logux](https://logux.org/recipes/tests.md)
- [Cross-Tab Communication with Logux](https://logux.org/recipes/cross-tab.md): We created Logux with thoughts that good UX means that user has the same state in every browser tab.
- [Supporting Different Versions of Client](https://logux.org/recipes/subprotocol.md): The client-server application should support different versions of the clients.
- [Logux Headers](https://logux.org/recipes/headers.md): Logux’s headers are an API to set session data like selected language.
- [Zero-Knowledge Server](https://logux.org/recipes/zero-knowledge.md): Zero-Knowledge Server is an answer to modern privacy problems, when server can’t read user’s data.
- [Deploying Logux Server](https://logux.org/recipes/deployment.md): Logux Server can be deployed to any hosting provider where Node.js is available.
- [Pagination with logux](https://logux.org/recipes/pagination.md): Example implementation of a real-time table with pagination.

## Examples

- [Logux Examples](https://logux.org/examples/list.md)

## Protocols

- [Logux Protocol](https://logux.org/protocols/ws/spec.md): Logux is a client-server communication protocol.
- [Logux Binary Protocol](https://logux.org/protocols/ws/binary.md): Logux Protocol has a binary form.
- [Logux Protocol Examples](https://logux.org/protocols/ws/examples.md)
- [Logux Protocol Changes](https://logux.org/protocols/ws/versions.md)

## API

- [Web API](https://logux.org/web-api.md): Reference for `@logux/client` with React, Vue, and Preact bindings.
- [Node API](https://logux.org/node-api.md): Reference for `@logux/server` and the Logux Core it is built on.

## Optional

- [Branding](https://logux.org/branding.md): Logux logo, font, and colors to download.