/codelnapps

Primary LanguagePython

Codeln 3D model App

ci-cd

Ce projet est une application web Django qui fonctionne avec Docker et Docker Compose. Il inclut une configuration pour lancer l'application localement en utilisant Docker.

Installation

Avec Docker

Pour exécuter ce projet localement, assurez-vous d'avoir installé Docker et Docker Compose sur votre système. Vous pouvez les installer en suivant les instructions officielles :

Une fois que Docker et Docker Compose sont installés, suivez ces étapes :

  1. Clonez le dépôt depuis GitHub :

    $ git clone https://github.com/Soro08/codelnapps.git
    $ cd codelnapps
    
  2. Copiez le fichier .env.example en tant que .env :

    $ cp .env.sample .env

    Modifiez les variables d'environnement dans le fichier .env selon vos besoins.

  3. Construisez les conteneurs Docker :

    $ docker-compose -f docker-compose.local.yml build
  4. Lancez les conteneurs Docker

    $ docker-compose -f docker-compose.local.yml up -d
    $ docker-compose -f docker-compose.local.yml exec web python manage.py create_badges
    
    $ docker-compose -f docker-compose.local.yml exec web python manage.py createsuperuser
  5. Les conteneurs Docker seront démarrés, et l'application sera accessible à l'adresse:

Sans Docker

  1. Clonez le dépôt depuis GitHub :

    $ git clone https://github.com/Soro08/codelnapps.git
    $ cd codelnapps
    
  2. Copiez le fichier .env.example en tant que .env :

    $ cp .env.sample .env

    Modifiez les variables d'environnement dans le fichier .env selon vos besoins.

  3. Créer et activer un environnement virtuel:

    $ python3.11 -m venv venv && source venv/bin/activate
  4. Installer les requirements:

    (venv)$ cd apps
    (venv)$ pip install -r requirements.txt
  5. Appliquer les migrations:

    (venv)$ python manage.py migrate
  6. Créer un superutilisateur et alimenter la base de données:

    (venv)$ python manage.py createsuperuser
    (venv)$ python manage.py create_badges
  7. Lancer le projet:

    (venv)$ python manage.py runserver

l'application sera accessible à l'adresse:

Fonctionnalités disponibles:

Vous pouvez accéder à la liste des fonctionnalitées de l'application à l'adresse suivante : https://codeln.soronbe.com/

Documentation

La documentation complète de ce projet via postman est disponible à l'adresse : https://documenter.getpostman.com/view/4931083/2s9YXe9581

Réalisé avec

Ce projet a été développé en utilisant les technologies suivantes :

  • Python Badge

  • Django Badge

  • Django REST framework Badge

  • Celery Badge

  • AWS S3 Badge

  • PostgreSQL Badge

  • Redis Badge

  • Docker Badge

  • Docker Compose Badge

  • Nginx-Proxy Badge

  • Postman Badge

  • Ubuntu Badge

  • GitHub Actions Badge

Ces technologies ont été soigneusement sélectionnées pour créer et déployer ce projet. Chacune d'entre elles a joué un rôle essentiel dans la conception, le développement et le déploiement de l'application.