mirror of
https://github.com/BreizhHardware/Jellystat.git
synced 2026-01-18 16:27:20 +01:00
f5eb983ab1
Fixed dependency errors Removed leftover logging commands from testing Updated screenshots
53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
<p align="center">
|
|
|
|
**Jellystat** is a free and open source Statistics App for Jellyfin! (This project is still in development - expect some weirdness)
|
|
|
|
## Current Features
|
|
|
|
- Session Monitoring and logging
|
|
- Statistics for all Libraries and Users
|
|
- Watch History
|
|
- User Overview and activity
|
|
- Watch statisitcs
|
|
- Backup and restore Data
|
|
|
|
## Required Development
|
|
- Responsive UI
|
|
- Code Optimizations
|
|
- Security Testing
|
|
- More Validations and Error Handling
|
|
- Auto sync library items
|
|
- Jellyfin Statistics Plugin Integration
|
|
- More to come
|
|
|
|
## Getting Started with Development
|
|
- Clone the project from git
|
|
- set your env variables before strating the server (Variable names as per the docker compose file).
|
|
- Run `npm init` to install necessary packages
|
|
- Run `npm run start-server` to only run the backend nodejs server
|
|
- Run `npm run start` to only run the frontend React UI
|
|
- Run `npm run start-app` to run both backend and frontend at the same time
|
|
|
|
|
|
### Launching Jellystat using Docker
|
|
|
|
Check out our dockerhub to run Jellystat:
|
|
https://hub.docker.com/r/cyfershepard/jellystat
|
|
|
|
## Screenshots
|
|
|
|
<img src="./screenshots/Home.PNG">
|
|
<img src="./screenshots/Users.PNG">
|
|
<img src="./screenshots/Activity.PNG">
|
|
<img src="./screenshots/Libraries.PNG">
|
|
<img src="./screenshots/settings.PNG.PNG">
|
|
|
|
## Support
|
|
|
|
- Bug reports and feature requests can be submitted via [GitHub Issues](https://github.com/CyferShepard/Jellystat/issues).
|
|
- Join us in our [Discord](https://discord.gg/9SMBj2RyEe)
|
|
|
|
## API Documentation
|
|
|
|
To-do
|