Cold Library Backend

Ce back permet de communiquer avec une base de données, des apis Jikan / MyAnimeList / Nyaa et Deluge Torrent afin de fournir les apis nécessaire à la gestion d'une base d'anime à télécharger. L'outil est en lien avec une connexion via Auth0 pour sécuriser les apis
Explore the docs »

View Demo · Report Bug · Request Feature

A propos du projet

Fonctionnalités

L'application possède plusieurs fonctionnalités :

• Faire des recherche d'anime via l'api Jikan
• Recherche de torrent via scrapping de Nyaa
• Lecture d'anime list via l'api de MyAnimeList
• Envoyer un torrent sur un serveur deluge
• Gerer une base de données d'anime et de telechargement

(back to top)

Construit avec

(back to top)

Pour bien démarrer

Prérequis

• Java 17 - Télécharger JDK 17 Témurin via IntelliJ IDEA ( Project Structures > Project > SDK > Add SDK > Download SDK > Version 17 > Vendor Eclipse Temurin (AdoptOpenJDK HotSpot) )
• Git - Télécharger et installer Git. Les machines OSX et Linux l'ont déjà d'installé.

Installation

1. Cloner le repo

   git clone https://github.com/zakaoai/cold-library-backend/.git

2. Ouvrer le projet avec IntelliJ et laisser le importer les dépendances

(back to top)

Utilisation

Démarrer l'application en local

Pour lancer l'application, assurez-vous que le port 9000 renseigné dans le fichier application.yml sur la config server:port ne correspond pas à une autre application lancer sur votre machine.

Lancer l'application

Depuis la racine du projet lancer la commande gradle suivante

   ./gradlew bootRun

ou Depuis IntelliJ, creer une nouvelle configuration projet Gradle avec les paramètres suivant :

• Run : bootRun

Authentification

L'application est protéger par une authentification gérée par auth0. Seuls les utilisateurs autorisés peuvent accéder aux endpoints protégé.

Rôles

La catégorisation des utilisateurs avec les rôles se fait dans Auth0, et en fonction de cette dernière le périmètre d'action dans l'outil est défini.

Pour plus d'informations sur son usage, merci de vous référer à la Documentation

(back to top)

Roadmap

• [ ]

Voir open issues pour une liste complete des feature ( et des issues connues)

(back to top)

Contribution

Si vous avez une suggestion pour améliorer les choses, veuillez créer une branche sur le dépôt et créer une pull request. Vous pouvez aussi simplement ouvrir un ticket avec la balise "enhancement". N'oubliez pas de donner une étoile au projet ! Merci encore!

1. Creer votre Feature Branch (git checkout -b feature/AmazingFeature)
2. Commit vos changements (git commit -m 'Add some AmazingFeature')
3. Push votre Branch (git push origin feature/AmazingFeature)
4. Open a Pull Request

(back to top)

Contact

Zakaoai

Lien projet: https://github.com/zakaoai/cold-library-backend/

(back to top)