Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
suchencjusz committed Jan 4, 2025
1 parent 6b8c23b commit 0c0782a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 17 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
![Black format](https://img.shields.io/badge/code%20style-black-000000.svg) ![GitHub License](https://img.shields.io/github/license/suchencjusz/filman2) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/suchencjusz/filman2) ![GitHub Action Docker](https://img.shields.io/github/actions/workflow/status/suchencjusz/filman2/docker-build.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/804ea9aa4ef147688ce59a0ab4342a09)](https://app.codacy.com/gh/suchencjusz/filman2/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

[Link z zaproszeniem bota na serwer discord](https://discord.com/oauth2/authorize?client_id=1182371658347065394&scope=bot&permissions=2147929152)

# Funkcje

🎬 Funkcje które są dostępne:
- Informowanie o ocenach znajomych (na ten moment tylko filmy)
- Informowanie o ocenach znajomych (seriale/filmy)
- Losowanie filmu do obejrzenia (z puli znajomych)

[![Bot discord](https://raw.githubusercontent.com/suchencjusz/filman2/refs/heads/main/readme/drive.png)](https://discord.com/oauth2/authorize?client_id=1182371658347065394&scope=bot&permissions=2147929152)
<!-- [![Bot discord](https://raw.githubusercontent.com/suchencjusz/filman2/refs/heads/main/readme/drive.png)](https://discord.com/oauth2/authorize?client_id=1182371658347065394&scope=bot&permissions=2147929152) -->

🚀 Planowane funkcje:
- Statyski (coś na zasadzie last.fm dla spotify),
- Losowanie filmu do obejrzenia (z puli znajomych),
- Sugerowanie filmu do obejrzenia (z puli znajomych, na podstawie ocen),
- Ocena gustu przez AI,

Expand All @@ -20,16 +18,17 @@
- /help configure

🤖 Przykładowa konfiguracja
- /configure channel text_channel:#ogólny
- /configure channel text_channel:#ogólny -
Konfiguracja kanału z powiadomieniami
- /filmweb me filmweb_username:
- /filmweb me filmweb_username: -
Uruchomienie śledzenie użytkownika

# Użycie

## 1. Zaproś bota
Poprostu użyj publicznego bota [link z zaproszeniem bota na serwer discord](https://discord.com/oauth2/authorize?client_id=1182371658347065394&scope=bot&permissions=2147929152)
[Link z zaproszeniem bota na serwer discord](https://discord.com/oauth2/authorize?client_id=1182371658347065394&scope=bot&permissions=2147929152)

## 2. Hostuj u siebie (docker)
(todo)

Docker compose [docker-compose.yml](https://github.com/suchencjusz/filman2/blob/main/docker-compose.yml)
26 changes: 17 additions & 9 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ services:

environment:
- SENTRY_ENABLED=false
- SENTRY_DSN=
# if you wish to use real sql db instead of sqlite uncomment this line (it is better way ofc)
# - SQLALCHEMY_DATABASE_URL=mysql://root:root1234@mariadb/filman_db
# - SENTRY_DSN=
# - SQLALCHEMY_DATABASE_URL=
# if you wish to use real sql db instead of sqlite uncomment this line (it is better way ofc)


extra_hosts:
- "host.docker.internal:host-gateway"
Expand All @@ -35,9 +36,8 @@ services:
- filman_server

environment:
- DISCORD_TOKEN= your discord bot token goes here
- LOG_LEVEL=DEBUG

- DISCORD_TOKEN=

networks:
- db

Expand All @@ -52,10 +52,18 @@ services:
environment:
- CORE_ENDPOINT=http://filman_server:8000
- SENTRY_ENABLED=false
- SENTRY_DSN=
# - SENTRY_DSN=

networks:
- db

restart: unless-stopped


watchtower:
image: containrrr/watchtower
container_name: watchtower
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /root/.docker/config.json:/config.json
command: --interval 60 filman_server filman_discord filman_crawler
restart: unless-stopped

0 comments on commit 0c0782a

Please sign in to comment.