English | Français

FossBadge is a free and open source platform for creating, managing, and sharing digital badges. It allows organizations to recognize skills and achievements through a simple, accessible interface.

• Create and manage digital badges with different skill levels (beginner, intermediate, expert)
• User profiles to showcase earned badges
• Organization/structure profiles to display available badges
• Accessible interface following FALC principles (Facile à Lire et à Comprendre / Easy to Read and Understand)
• Mobile-responsive design
• QR codes for badge verification

• Django 5.2+
• Bootstrap 5
• HTMX for dynamic interactions
• SQLite database (development)
• Crispy Forms with Bootstrap 5 template pack

1. Clone the repository:

   git clone https://github.com/CoopCodeCommun/FossBadge.git
   cd fossbadge

2. Install dependencies using uv (optional, uv does it automatically):

   uv sync

3. Apply migrations:

   uv run python manage.py migrate

4. Populate the database (optional):

   uv run python manage.py populate_db --img

5. Create a superuser (optional):

   uv run python manage.py createsuperuser

6. Run the development server:

   uv run python manage.py runserver

7. Access the application at http://127.0.0.1:8000/

Run the tests :

  uv run python manage.py test

1. Set Debug to False in fossbadge/settings.py.
2. Install docker
3. Create à .env file : $ cp env_exemple .env and edit its values
4. Create a network in docker : $ docker network create frontend
5. Run the docker compose : $ docker compose -f docker-compose-prod.yml up

After that, nginx will run on port 80.

• core/: Main application with views, models, and templates
• fossbadge/: Project settings and configuration
• static/: Static files (CSS, JavaScript, images)
• templates/: HTML templates
• media/: User-uploaded files (badge icons, profile pictures)

Contributions are welcome! Please feel free to submit a Pull Request.

This project is licensed under the AGPLv3 License - see the LICENSE file for details.

FossBadge est une plateforme libre et open source pour créer, gérer et partager des badges numériques. Elle permet aux organisations de reconnaître les compétences et les réalisations à travers une interface simple et accessible.

• Création et gestion de badges numériques avec différents niveaux de compétence (débutant, intermédiaire, expert)
• Profils utilisateurs pour présenter les badges obtenus
• Profils d'organisations/structures pour afficher les badges disponibles
• Interface accessible suivant les principes FALC (Facile à Lire et à Comprendre)
• Design responsive pour mobile
• Codes QR pour la vérification des badges

• Django 5.2+
• Bootstrap 5
• HTMX pour les interactions dynamiques
• Base de données SQLite (développement)
• Crispy Forms avec le pack de templates Bootstrap 5

1. Cloner le dépôt :

   git clone https://github.com/CoopCodeCommun/FossBadge.git
   cd fossbadge

2. Installer les dépendances avec uv (optionnel, uv le fait automatiquement):

   uv sync

3. Appliquer les migrations :

   uv run python manage.py migrate

4. Remplir la base de données (optionnel) :

   uv run python manage.py populate_db --img

5. Créer un super utilisateur (optionnel) :

   uv run python manage.py createsuperuser

6. Lancer le serveur de développement :

   uv run python manage.py runserver

7. Accéder à l'application à l'adresse http://127.0.0.1:8000/

Lancer les tests :

    uv run python manage.py test

1. Mettre Debug à False dans fossbadge/settings.py.
2. Installer docker
3. Créer un fichier .env : $ cp env_exemple .env et éditer ses valeurs
4. Créer un réseau dans docker : $ docker network create frontend
5. Lancer le docker compose : $ docker compose -f docker-compose-prod.yml up

Après ça, nginx tournera sur le port 80.

• core/ : Application principale avec les vues, modèles et templates
• fossbadge/ : Paramètres et configuration du projet
• static/ : Fichiers statiques (CSS, JavaScript, images)
• templates/ : Templates HTML
• media/ : Fichiers téléchargés par les utilisateurs (icônes de badges, photos de profil)

Les contributions sont les bienvenues ! N'hésitez pas à soumettre une Pull Request.

Ce projet est sous licence AGPLv3 - voir le fichier LICENSE pour plus de détails.