https://github.com/pablouser1/aio-github-card
https://github.com/pablouser1/aio-github-card
backloggd trakt trakt-api trakt-tv
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pablouser1/aio-github-card
- Owner: pablouser1
- License: agpl-3.0
- Created: 2022-01-08T00:35:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-10T16:59:16.000Z (11 months ago)
- Last Synced: 2025-04-04T14:51:16.712Z (6 months ago)
- Topics: backloggd, trakt, trakt-api, trakt-tv
- Language: PHP
- Homepage: https://gh-cards.pabloferreiro.es
- Size: 206 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# All-in-one Github Card
Dynamic cards for your Github README for multiple services using PHP >= 8.0
## Supported services
* Trakt (https://trakt.tv)
* Backloggd (https://backloggd.com)
## Usage
You can interactively generate your Markdown [here](https://gh-cards.pabloferreiro.es)
## Self-hosting
### Installation
Clone the repository and fetch the requiered external packages with:
```bash
composer install
```
Then you can run it locally using for example the PHP Development Server with:
```bash
php -S localhost:8000 api/index.php
```
### Config
You need to create a new application on Trakt [here](https://trakt.tv/oauth/applications/new), then copy the CLIENT_ID to .env
### .env
Move the .env.example file to .env and modify it.
### Apache
You don't have to do anything more
### Nginx
Add the following to your config (you can modify the aio-card part if you have or not a subdir):
```
location /aio-card {
return 302 $scheme://$host/aio-card/;
}
location /aio-card/ {
try_files $uri $uri/ /aio-card/api/index.php?$query_string;
}
location /aio-card/.env {
deny all;
return 404;
}
```
## TODO
* Scrolling text
* Better designs
* Better themes system
## Credits
* [Backloggd](https://backloggd.com)
* [Trakt](https://trakt.tv)
* [TheMovieDB](https://themoviedb.org)