Skip to content

Commit

Permalink
Merge pull request #59 from Mahmoud-Barry/read-me
Browse files Browse the repository at this point in the history
Read me
  • Loading branch information
daoodaba975 authored Oct 31, 2024
2 parents de45ebc + fe36835 commit 0077b85
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Galsen UI

# GalsenUI

**GalsenUI** est une bibliothèque de composants **Tailwind CSS** et **CSS pur** réutilisables, conçue pour la communauté des développeurs du Sénégal. Ce projet **made in Senegal** a pour but de partager des éléments UI modernes et flexibles pour aider les développeurs à accélérer la création de projets et renforcer les initiatives de la communauté **Galsen Dev**.
**Galsen UI** est une bibliothèque de composants **Tailwind CSS** et **CSS pur** réutilisables, conçue pour la communauté des développeurs du Sénégal. Ce projet **made in Senegal** a pour but de partager des éléments UI modernes et flexibles pour aider les développeurs à accélérer la création de projets.
Ce projet vient renforcer les projets et activités de la communauté **Galsen DEV**.

## Sommaire

- [GalsenUI](#galsenui)
- [Galsen UI](#galsen-ui)
- [Sommaire](#sommaire)
- [Aperçu du projet](#aperçu-du-projet)
- [Prérequis](#prérequis)
Expand All @@ -17,15 +17,29 @@

## Aperçu du projet

**GalsenUI** propose une collection de composants UI prêts à l'emploi, faciles à intégrer dans vos projets. Conçus avec **Tailwind CSS** et **CSS pur**, ces composants sont entièrement personnalisables, réactifs, et adaptés aux besoins des développeurs modernes.
**Galsen UI** propose une collection de composants UI prêts à l'emploi, faciles à intégrer dans vos projets. Conçus avec **Tailwind CSS** et **CSS** pur, ces composants sont entièrement personnalisables, réactifs, et adaptés aux besoins des développeurs modernes.

L’objectif est de fournir aux développeurs une base solide pour créer des applications élégantes et accessibles, en s'appuyant sur les meilleures pratiques de développement front-end.

![NextJS](https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=next.js&logoColor=white)
![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
![MDX](https://img.shields.io/badge/MDX-1B1F24?style=for-the-badge&logo=mdx&logoColor=white)

---

![Made-In-Senegal](./public/svgs/madeinsenegal.svg)

🚧 Si vous souhaitez contribuer à ce projet, veuillez lire **[CONTRIBUTING.md](../CONTRIBUTING.md)** d'abord !

---

## Prérequis

Avant de commencer, assurez-vous davoir les éléments suivants installés :
Avant de commencer, assurez-vous d'avoir les éléments suivants installés :

- **Node.js** (version 20.x ou supérieure recommandée) - [Télécharger Node.js](https://nodejs.org)
- Node.js (Version 20.x ou supérieure recommandée) : [Télécharger Node.js](https://nodejs.org)

## Installation

Expand Down Expand Up @@ -65,7 +79,7 @@ Une fois le projet lancé, ouvrez votre navigateur et accédez à [http://localh

## Contribuer

Les contributions sont les bienvenues ! Pour contribuer à **GalsenUI**, suivez les étapes ci-dessous :
Les contributions sont les bienvenues ! Pour contribuer à **Galsen UI**, suivez les étapes ci-dessous :

1. **Fork** le dépôt.
2. **Créez une branche** pour votre fonctionnalité (`git checkout -b fonctionnalité/ma-fonctionnalité`).
Expand All @@ -79,4 +93,5 @@ Nous vous invitons également à consulter notre [Code de Conduite](CODE_OF_COND

Ce projet est sous licence [MIT](LICENSE.md). Vous êtes libre de l'utiliser et de le modifier selon vos besoins.

Merci d'utiliser **GalsenUI** et de soutenir la communauté Galsen Dev ! Pour toute question, suggestion ou amélioration, n'hésitez pas à nous contacter.
Merci d'utiliser **Galsen UI** et de soutenir la communauté Galsen DEV !
Pour toute question, suggestion ou amélioration, n'hésitez pas à nous contacter.
29 changes: 29 additions & 0 deletions public/svgs/madeinsenegal.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0077b85

Please sign in to comment.