v0.4.7

README.md

@@ -1,16 +1,46 @@
-# discoursio-api
+# GraphQL API Backend
 
-## Техстек
+Backend service providing GraphQL API for content management system with reactions, ratings and comments.
 
-- sqlalchemy
-- redis
-- ariadne
-- starlette
-- granian
+## Core Features
 
-## Локальная разработка
+### Shouts (Posts)
+- CRUD operations via GraphQL mutations
+- Rich filtering and sorting options
+- Support for multiple authors and topics
+- Rating system with likes/dislikes
+- Comments and nested replies
+- Bookmarks and following
 
-Запустите API-сервер с ключом `dev`:
+### Reactions System
+- `ReactionKind` types: LIKE, DISLIKE, COMMENT
+- Rating calculation for shouts and comments
+- User-specific reaction tracking
+- Reaction stats and aggregations
+- Nested comments support
+
+### Authors & Topics
+- Author profiles with stats
+- Topic categorization and hierarchy
+- Following system for authors/topics
+- Activity tracking and stats
+- Community features
+
+## Tech Stack
+
+- **(Python)[https://www.python.org/]** 3.12+
+- **GraphQL** with [Ariadne](https://ariadnegraphql.org/)
+- **(SQLAlchemy)[https://docs.sqlalchemy.org/en/20/orm/]**
+- **(PostgreSQL)[https://www.postgresql.org/]/(SQLite)[https://www.sqlite.org/]** support
+- **(Starlette)[https://www.starlette.io/]** for ASGI server
+- **(Redis)[https://redis.io/]** for caching
+
+## Development
+
+### Setup
+
+
+Start API server with `dev` key:
 
 ```shell
 mkdir .venv
@@ -20,10 +50,43 @@ poetry update
 poetry run server.py dev
 ```
 
-### Полезные команды
+### Useful Commands
 
 ```shell
-poetry run ruff check . --fix --select I # линтер и сортировка импортов
-poetry run ruff format . --line-length=120 # форматирование кода
+# Linting and import sorting
+poetry run ruff check . --fix --select I 
+
+# Code formatting
+poetry run ruff format . --line-length=120 
+
+# Run tests
+poetry run pytest
+
+# Type checking
+poetry run mypy .
 ```
 
+### Code Style
+
+We use:
+- Ruff for linting and import sorting
+- Line length: 120 characters
+- Python type hints
+- Docstrings for public methods
+
+### GraphQL Development
+
+Test queries in GraphQL Playground at `http://localhost:8000`:
+
+```graphql
+# Example query
+query GetShout($slug: String) {
+  get_shout(slug: $slug) {
+    id
+    title
+    main_author {
+      name
+    }
+  }
+}
+```