https://github.com/nktfh100/stremio-simkl
Stremio addon to display your Simkl Watchlists.
https://github.com/nktfh100/stremio-simkl
simkl stremio stremio-addon
Last synced: about 1 month ago
JSON representation
Stremio addon to display your Simkl Watchlists.
- Host: GitHub
- URL: https://github.com/nktfh100/stremio-simkl
- Owner: nktfh100
- Created: 2023-12-25T19:44:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-21T07:42:20.000Z (2 months ago)
- Last Synced: 2025-04-09T22:53:13.900Z (about 1 month ago)
- Topics: simkl, stremio, stremio-addon
- Language: TypeScript
- Homepage: https://stremio-simkl.malachi.io
- Size: 754 KB
- Stars: 17
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Stremio Simkl Watchlists Addon
Stremio addon to display your Simkl Watchlists.
## Install addon
[Install addon](https://stremio-simkl.malachi.io)
## Development
1. Create `.env` files inside the `backend` and `frontend` folders based on the `.env.example` files.
2. You will need a TMDB API key, an RPDB API key (optional), and a Simkl app.
- To create a Simkl app, visit: [Simkl Developer Settings](https://simkl.com/settings/developer/).
3. Install dependencies for both the frontend and backend:
```sh
npm run install
```
4. Start the development environment, which includes the Redis server, frontend, and backend:
```sh
npm run dev
```
This will run the following commands concurrently:
- `start:redis`: Starts the Redis server using Docker Compose.
- `dev:frontend`: Starts the frontend development server.
- `dev:backend`: Starts the backend development server.
## Tech Stack
The backend is a simple and stateless express server that uses redis to cache the TMDB API responses.
The user configuration for the addon (Simkl user token) is encrypted using aes-192-cbc.
### Backend
- Typescript
- Node.js
- Express
- Redis (for caching)
- Prometheus (for metrics)
### Frontend
- Typescript
- React
- Vite
- Zustand (state management)
## Contributing
Contributions are welcome!
if you have any suggestions or issues please open an issue or a pull request.