This commit is contained in:
parent
eb2140bcc6
commit
b2df345072
47
README.md
47
README.md
|
@ -2,14 +2,19 @@
|
|||
|
||||
<div align="center">
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
</div>
|
||||
|
||||
|
@ -17,15 +22,11 @@ Backend service providing GraphQL API for content management system with reactio
|
|||
|
||||
## 📚 Documentation
|
||||
|
||||
• [API Documentation](docs/api.md)
|
||||
• [Authentication Guide](docs/auth.md)
|
||||
• [Caching System](docs/redis-schema.md)
|
||||
• [Features Overview](docs/features.md)
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
- [API Documentation](docs/api.md)
|
||||
- [Authentication Guide](docs/auth.md)
|
||||
- [Caching System](docs/redis-schema.md)
|
||||
- [Features Overview](docs/features.md)
|
||||
- [RBAC System](docs/rbac-system.md)
|
||||
|
||||
## 🚀 Core Features
|
||||
### Shouts (Posts)
|
||||
|
@ -56,14 +57,15 @@ Backend service providing GraphQL API for content management system with reactio
|
|||
## 🛠️ Tech Stack
|
||||
|
||||
**Core:** Python 3.12 • GraphQL • PostgreSQL • SQLAlchemy • JWT • Redis • txtai
|
||||
**Server:** Starlette • Granian • Nginx
|
||||
**Tools:** Pytest • MyPy • Ruff
|
||||
**Deploy:** Dokku • Gitea • Glitchtip
|
||||
**Server:** Starlette • Granian 1.8.0 • Nginx
|
||||
**Frontend:** SolidJS 1.9.1 • TypeScript 5.7.2 • Vite 5.4.11
|
||||
**GraphQL:** Ariadne 0.23.0
|
||||
**Tools:** Pytest • MyPy • Biome 2.0.6
|
||||
|
||||
## 🔧 Development
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
### 📦 Prepare environment:
|
||||
|
@ -92,11 +94,14 @@ python -m granian main:app --interface asgi
|
|||
### ⚡ Useful Commands
|
||||
|
||||
```shell
|
||||
# Linting and import sorting
|
||||
ruff check . --fix --select I
|
||||
# Linting and formatting with Biome
|
||||
biome check . --write
|
||||
|
||||
# Code formatting
|
||||
ruff format . --line-length=120
|
||||
# Lint only
|
||||
biome lint .
|
||||
|
||||
# Format only
|
||||
biome format . --write
|
||||
|
||||
# Run tests
|
||||
pytest
|
||||
|
@ -114,7 +119,7 @@ python -m granian main:app --interface asgi
|
|||

|
||||

|
||||
|
||||
**Ruff** for linting • **120 char** lines • **Type hints** required • **Docstrings** for public methods
|
||||
**Biome 2.0.6** for linting and formatting • **120 char** lines • **Type hints** required • **Docstrings** for public methods
|
||||
|
||||
### 🔍 GraphQL Development
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user