mirror of
https://github.com/jorisbertomeu/web-screensaver.git
synced 2026-04-19 16:27:40 +02:00
Update readme
This commit is contained in:
29
.dockerignore
Normal file
29
.dockerignore
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
node_modules
|
||||||
|
npm-debug.log
|
||||||
|
yarn-error.log
|
||||||
|
.pnpm-debug.log
|
||||||
|
package-lock.json
|
||||||
|
yarn.lock
|
||||||
|
|
||||||
|
node_modules
|
||||||
|
dist
|
||||||
|
.angular
|
||||||
|
.angular-cache
|
||||||
|
.cache
|
||||||
|
|
||||||
|
.env
|
||||||
|
.npmrc
|
||||||
|
.DS_Store
|
||||||
|
.eslintcache
|
||||||
|
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
|
||||||
|
*.idea
|
||||||
|
*.vscode
|
||||||
|
.DS_Store
|
||||||
|
|
||||||
|
**/coverage
|
||||||
|
**/tests
|
||||||
|
**/test
|
||||||
|
**/spec
|
||||||
42
.gitignore
vendored
Normal file
42
.gitignore
vendored
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
# See https://docs.github.com/get-started/getting-started-with-git/ignoring-files for more about ignoring files.
|
||||||
|
|
||||||
|
# Compiled output
|
||||||
|
dist
|
||||||
|
tmp
|
||||||
|
out-tsc
|
||||||
|
bazel-out
|
||||||
|
|
||||||
|
# Node
|
||||||
|
node_modules
|
||||||
|
npm-debug.log
|
||||||
|
yarn-error.log
|
||||||
|
|
||||||
|
# IDEs and editors
|
||||||
|
.idea/
|
||||||
|
.project
|
||||||
|
.classpath
|
||||||
|
.c9/
|
||||||
|
*.launch
|
||||||
|
.settings/
|
||||||
|
*.sublime-workspace
|
||||||
|
|
||||||
|
# Visual Studio Code
|
||||||
|
.vscode/*
|
||||||
|
!.vscode/settings.json
|
||||||
|
!.vscode/tasks.json
|
||||||
|
!.vscode/launch.json
|
||||||
|
!.vscode/extensions.json
|
||||||
|
.history/*
|
||||||
|
|
||||||
|
# Miscellaneous
|
||||||
|
/.angular/cache
|
||||||
|
.sass-cache/
|
||||||
|
/connect.lock
|
||||||
|
/coverage
|
||||||
|
/libpeerconnection.log
|
||||||
|
testem.log
|
||||||
|
/typings
|
||||||
|
|
||||||
|
# System files
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
99
README.md
99
README.md
@@ -1,27 +1,98 @@
|
|||||||
# WebScreensaver
|
# 🖼️ Web Screensaver
|
||||||
|
|
||||||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.5.
|
[](https://angular.io/)
|
||||||
|
[](https://nodejs.org/)
|
||||||
|
[](https://unsplash.com/)
|
||||||
|
[](https://www.home-assistant.io/)
|
||||||
|
|
||||||
## Development server
|
Un écran de veille web moderne qui affiche une horloge élégante, des photos Unsplash et des widgets Home Assistant personnalisables. Parfait pour les tableaux de bord d'information, les écrans d'ambiance ou l'écran de veille de Fully Kiosk.
|
||||||
|
|
||||||
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
|
[](./imgs/dash.png)
|
||||||
|
|
||||||
## Code scaffolding
|
## ✨ Fonctionnalités
|
||||||
|
|
||||||
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
|
- 🕒 Horloge élégante avec date
|
||||||
|
- 📸 Rotation automatique de fonds d'écran via Unsplash avec choix du thème
|
||||||
|
- 🏠 Intégration avec Home Assistant
|
||||||
|
- 🎛️ Widgets personnalisables
|
||||||
|
- ⚙️ Interface d'administration intuitive
|
||||||
|
- 📱 Design responsive
|
||||||
|
- 🎨 Thème moderne
|
||||||
|
|
||||||
## Build
|
## 🚀 Installation
|
||||||
|
|
||||||
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
|
### Prérequis
|
||||||
|
|
||||||
## Running unit tests
|
- Docker
|
||||||
|
- Compte développeur Unsplash (Facultatif)
|
||||||
|
|
||||||
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
|
### Build de l'image Docker
|
||||||
|
Se placer dans le répertoire du projet:
|
||||||
|
|
||||||
## Running end-to-end tests
|
``docker build -t web-screensaver .``
|
||||||
|
|
||||||
Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
|
### Démarrer le container
|
||||||
|
|
||||||
## Further help
|
``docker run -d -v ./api/res:/app/api/res -p 80:80 --name my-web-screensaver web-screensaver``
|
||||||
|
|
||||||
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
|
Le service écoute alors sur le port 8080. Vous pouvez vous y rendre via http://<IP>:8080 pour accéder au dashboard ou sur http://<IP>:8080/admin pour accéder à l'interface d'administration.
|
||||||
|
|
||||||
|
## ⚙️ Configuration
|
||||||
|
|
||||||
|
### Interface d'administration
|
||||||
|
|
||||||
|
L'interface d'administration (`/admin`) permet de configurer :
|
||||||
|
|
||||||
|
#### Paramètres principaux
|
||||||
|
- ⏱️ Délai de rafraîchissement des fonds d'écran
|
||||||
|
- 📐 Résolution native
|
||||||
|
- 🔑 Clés d'API Unsplash
|
||||||
|
- 📂 Collections Unsplash
|
||||||
|
|
||||||
|
#### Configuration Home Assistant
|
||||||
|
- 🔗 URL du serveur
|
||||||
|
- 🔑 Token d'accès longue durée
|
||||||
|
- 🎛️ Configuration des widgets
|
||||||
|
- Entités HASS
|
||||||
|
- Icônes FontAwesome
|
||||||
|
- Préfixes et suffixes personnalisés
|
||||||
|
|
||||||
|
## 🖥️ Interface utilisateur
|
||||||
|
|
||||||
|
### Dashboard (`/` or `/dashboard`)
|
||||||
|
|
||||||
|
[](./imgs/dash.png)
|
||||||
|
|
||||||
|
### Admin (`/admin`)
|
||||||
|
|
||||||
|
[](./imgs/admin.png)
|
||||||
|
|
||||||
|
## 📝 Notes de version
|
||||||
|
|
||||||
|
### Version 1.0.2
|
||||||
|
- ✨ Nouveau design des widgets
|
||||||
|
- 🐛 Corrections de bugs
|
||||||
|
- 🚀 Optimisation des performances
|
||||||
|
|
||||||
|
## 🤝 Contribution
|
||||||
|
|
||||||
|
Les contributions sont les bienvenues ! N'hésitez pas à :
|
||||||
|
|
||||||
|
1. Fork le projet
|
||||||
|
2. Créer une branche (`git checkout -b feature/AmazingFeature`)
|
||||||
|
3. Commit (`git commit -m 'Add AmazingFeature'`)
|
||||||
|
4. Push (`git push origin feature/AmazingFeature`)
|
||||||
|
5. Ouvrir une Pull Request
|
||||||
|
|
||||||
|
## 📜 Licence
|
||||||
|
|
||||||
|
Distribué sous la licence MIT.
|
||||||
|
|
||||||
|
## 🙏 Remerciements
|
||||||
|
|
||||||
|
- [Unsplash](https://unsplash.com) pour les magnifiques photos
|
||||||
|
- [Home Assistant](https://www.home-assistant.io/) pour leur excellente API
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Fait avec ❤️ par Joris Bertomeu
|
||||||
BIN
imgs/admin.png
Normal file
BIN
imgs/admin.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 175 KiB |
BIN
imgs/dash.png
Normal file
BIN
imgs/dash.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.0 MiB |
Reference in New Issue
Block a user