Giter Club home page Giter Club logo

partiel_m1miai's Introduction

Getting started with the app

This repository contains an API server written in Python that uses MongoDB as a database. The API allows clients to create stores and add or delete musics to those stores. To get started with the app, you will need to have Docker and docker-compose installed on your system.

Installing Docker and docker-compose

You can download Docker from the official website: https://www.docker.com/get-started. Once you have Docker installed, you can install docker-compose by following the instructions here: https://docs.docker.com/compose/install/.

Starting the app

To start the app, follow these steps:

  1. Clone this repository to your local machine:
git clone https://github.com/Jofresh/PARTIEL-M1MIAI.git
  1. Change into the cloned directory:
cd PARTIEL-M1MIAI/
  1. Run the following command to start the app:
docker-compose up -d --build
  1. Visit http://localhost:4850/docs once the containers are up and running. You can use tools like Postman or cURL to send requests to the API endpoints.

Stopping the app

To stop the app, run the following command:

docker-compose down

This will stop and remove the Docker containers that were created when the app was started.

partiel_m1miai's People

Contributors

jofresh avatar

Stargazers

Samy avatar

Watchers

 avatar

partiel_m1miai's Issues

rest-api

Architecture souhaitée :

  • Une API REST, exposée sur le port 4850, avec de nombreux points de terminaison permettant d’interagir avec la base de données (en python + FastAPI)
  • Une base de données pour enregistrer les titres musicaux associés aux listes de titres musicaux (avec le choix de la technologie)

Commencer par :

  • Créer simplement les endpoints
Méthode Route Body Description
GET /music Renvoie la liste des musiques
POST /music { title, artist, registration } Créé une musique
GET /music/{id} Renvoie les informations d'une musique
PUT /music/{id} { title, artist, registration } Modifie les informations d'une musique
DELETE /music/{id} Supprime une musique
GET /store Renvoie la liste des magasins
POST /store { type } Créé un magasin
GET /store/{id} Renvoie les informations d'un magasin
PUT /store/{id} { type } Modifie les informations d'un magasin
DELETE /store/{id} Supprime un magasin
PUT /store/{store_id}/music/{music_id} {} Ajoute une musique dans un magasin
  • Ajouter les modèles aux endpoints (#1)
  • Utiliser la base de données à chaque endpoint/requête

Enfin, conteneuriser l'application avec :

  • Un conteneur contenant la bdd
  • Un conteneur contenant l'app

pydantic-models

Créer les schémas/modèles pydantic qui seront utiles pour l'API, en fonction de la définition de ces deux classes / modèles :

  • Le modèle Magasin :
    • encapsule un type de musique et deux listes, la première stockant les musiques disponibles en format vinyle, la seconde en format DVD ;
    • dispose de méthode pour accéder à ces informations et ajouter/retirer des titres aux listes ;
  • Le modèle Musique qui encapsule un titre, un nom d’artiste et une immatriculation : deux lettres, trois chiffres, trois lettres et quatre chiffres séparés par des slashs, e.g. JH/250/POP/1234

Attention :

  • Le magasin doit être composé de musiques compatibles avec son type de musique et chaque musique doit avoir une immatriculation valide.
  • Une immatriculation de musique est valide si :
    • les deux premières lettres sont les initiales de l’artiste
    • la suite de trois chiffres, représentant la durée de la musique en seconde, est supérieur à une minute et inférieur à cinq minutes
    • les trois lettres représentent un type de musique parmi RAP, POP, RNB
    • les quatre derniers chiffres sont un identifiant ne contenant pas de 6

seeder

Créer un script remplissant automatiquement la base de données avec des données valides prédéfinies par vos choix (en python)

Exécuter un conteneur qui lance ce script (créer une image) en plus des conteneurs déjà créés (#2)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.