mirror of
https://github.com/partitioncloud/partitioncloud-server.git
synced 2025-04-22 13:43:55 +02:00
74 lines
2.8 KiB
Markdown
74 lines
2.8 KiB
Markdown
# partitioncloud-server
|
|
|
|
Serveur web (basé sur Flask) pour gérer sa collection de partitions musicales
|
|
|
|
## Features
|
|
|
|
### Liste non exhaustive
|
|
- recherche de partitions en ligne et ajout à la base de données (recherche Google)
|
|
- partage d'un album par un lien direct sans nécessité de connexion (en lecture seule)
|
|
- Thème sombre (je ne suis pas satisfait du résultat, mais il est à peu près correct)
|
|
- dashboard administrateur: gestion de tous les albums, partitions et utilisateurs
|
|
- [CLI](https://github.com/partitioncloud/partitioncloud-cli) uniquement à des fins de synchronisation. Il serait bon d'ajouter une BDD locale avec les UUIDs des partitions
|
|
- Pas de Javascript
|
|
|
|
## Points à noter
|
|
- Les partitions ajoutées sont accessibles à tous les utilisateurs depuis la recherche même si ils ne sont pas dans un album leur y donnant accès, pour limiter la redondance
|
|
- Il est possible d'entrer des paroles en créant une partitions, celles-ci sont utilisées uniquement pour la recherche
|
|
- Les résultats de la recherche web sont téléchargés automatiquement pour en générer un aperçu
|
|
- Le fichier de configuration est utilisé par le script `make.sh` ainsi que l'interpréteur python
|
|
|
|
## Installation
|
|
|
|
Installer le serveur
|
|
```bash
|
|
# Clone this repo
|
|
git clone https://github.com/partitioncloud/partitioncloud-server.git
|
|
cd partitioncloud-server
|
|
# Install dependencies
|
|
pip install -r requirements.txt
|
|
# Create database and folders
|
|
./make.sh init
|
|
```
|
|
|
|
Démarrer le serveur
|
|
```bash
|
|
./make.sh start
|
|
```
|
|
|
|
Pour démarrer sur un environnement complet (plus que pour du dev/test),
|
|
Installer [`gunicorn`](https://github.com/benoitc/gunicorn) puis:
|
|
```bash
|
|
./make.sh prod
|
|
```
|
|
|
|
## Configuration
|
|
|
|
```bash
|
|
cp default_config.py instance/config.py
|
|
```
|
|
Modifier le fichier de configuration créé
|
|
|
|
## Screenshots
|
|
|
|
### Interface principale
|
|
|
|
|
|
|
|
### Tableau administrateur
|
|
|
|
|
|
|
|
### Recherche en ligne et locale
|
|
|
|
_Les noms des sites webs ont volontairement été supprimés_
|
|
|
|
|
|
|
|
## TODO
|
|
- [ ] Modifier son mot de passe
|
|
- [ ] Supprimer un utilisateur
|
|
- [ ] Ajouter config:DISABLE_DARK_MODE
|
|
- [ ] Ajouter config:DISABLE_REGISTER
|
|
- [ ] Ajouter config:ONLINE_SEARCH_BASE_QUERY pour la recherche google, actuellement 'filetype:pdf partition'
|