Skip to content

Commit 4277653

Browse files
LoupesDEVLoupesDEV
committed
📝 add all documentations
1 parent 5678113 commit 4277653

7 files changed

Lines changed: 340 additions & 0 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: LoupesDEV

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
28+
- OS: [e.g. iOS]
29+
- Browser [e.g. chrome, safari]
30+
- Version [e.g. 22]
31+
32+
**Smartphone (please complete the following information):**
33+
34+
- Device: [e.g. iPhone6]
35+
- OS: [e.g. iOS8.1]
36+
- Browser [e.g. stock browser, safari]
37+
- Version [e.g. 22]
38+
39+
**Additional context**
40+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/custom.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Custom issue template
3+
about: Describe this issue template's purpose here.
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

‎CODE_OF_CONDUCT.md‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement in the “Issues” tab.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.0, available at
118+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
120+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121+
enforcement ladder](https://github.com/mozilla/diversity).
122+
123+
[homepage]: https://www.contributor-covenant.org
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
https://www.contributor-covenant.org/faq. Translations are available at
127+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Guide de Contribution
2+
3+
Merci de votre intérêt pour ce projet ! Nous accueillons toutes les contributions, qu'il s'agisse de signaler un bug,
4+
d'ajouter une fonctionnalité ou d'améliorer la documentation. Veuillez suivre ces instructions pour contribuer
5+
efficacement.
6+
7+
## Comment Contribuer ?
8+
9+
### 1. Signaler un Bug
10+
11+
Si vous trouvez un bug, ouvrez une issue en incluant :
12+
13+
- Une description claire du problème.
14+
- Les étapes pour reproduire le bug.
15+
- Les résultats attendus et obtenus.
16+
- Toute information système pertinente (OS, version du logiciel, etc.).
17+
18+
### 2. Suggérer une Amélioration ou une Fonctionnalité
19+
20+
Avant de proposer une nouvelle fonctionnalité, consultez les issues existantes pour éviter les doublons. Si votre idée
21+
est nouvelle :
22+
23+
- Décrivez clairement la fonctionnalité souhaitée.
24+
- Expliquez pourquoi elle est utile.
25+
- Proposez éventuellement une implémentation.
26+
27+
### 3. Soumettre une Pull Request (PR)
28+
29+
1. **Forkez** le dépôt et clonez votre copie.
30+
2. **Créez une branche** pour votre contribution :
31+
```bash
32+
git checkout -b feature/ma-fonctionnalite
33+
```
34+
3. **Faites vos modifications** en respectant les conventions du projet.
35+
4. **Testez** votre code avant de le soumettre.
36+
5. **Faites un commit** avec un message clair :
37+
```bash
38+
git commit -m "Ajout de [fonctionnalité]"
39+
```
40+
6. **Poussez** votre branche et ouvrez une Pull Request.
41+
42+
## Bonnes Pratiques
43+
44+
- Respectez la structure et le style du code.
45+
- Documentez votre code si nécessaire.
46+
- Assurez-vous que toutes les modifications passent les tests existants.
47+
- Soyez courtois et respectueux dans vos interactions.
48+
49+
## Contact
50+
51+
Si vous avez des questions, ouvrez une issue ou contactez un mainteneur du projet.
52+
53+
Merci pour votre contribution ! 🚀

‎README.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<div align="center">
2+
<img src="assets/cyrex.png" alt="Cyrex Studio Logo" width="140">
3+
</div>
4+
5+
<h1 align="center">Cyrex Studio</h1>
6+
7+
<div align="center">
8+
<p>Portfolio interactif présentant nos expertises, projets et technologies.</p>
9+
<img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/HTML/html3.svg">
10+
<img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/CSS/css3.svg">
11+
<img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/Javascript/javascript3.svg">
12+
</div>
13+
14+
<br>
15+
16+
## Table des matières
17+
18+
- [Comment utiliser Cyrex Studio](#comment-utiliser-cyrex-studio)
19+
- [Fonctionnalités](#fonctionnalités)
20+
- [Démo](#démo)
21+
- [Structure du projet](#structure-du-projet)
22+
- [Contributeurs](#contributeurs)
23+
24+
# Comment utiliser Cyrex Studio
25+
26+
Pour visualiser le site, suivez ces étapes :
27+
28+
1. **Cloner le dépôt**
29+
30+
```bash
31+
git clone https://github.com/LoupesDEV/Cyrex-Studio.git
32+
```
33+
34+
2. **Lancer un serveur local** (facultatif, mais recommandé)
35+
36+
* Avec **VSCode** : clic droit sur `index.html` → **Open with Live Server**.
37+
* Avec **Python** :
38+
39+
```bash
40+
python3 -m http.server 8000
41+
```
42+
43+
3. **Accéder au site**
44+
45+
Ouvrez [http://localhost:8000](http://localhost:8000) dans votre navigateur.
46+
47+
> 💡 *Le projet fonctionne directement en ouvrant `index.html` dans votre navigateur, sans installation supplémentaire.*
48+
49+
# Fonctionnalités
50+
51+
* **Page d’accueil immersive** 🎨 : Hero avec logo animé et CTA.
52+
* **Expertises** 🛠️ : Présentation des services (Sécurité, Web, Logiciel, Consulting).
53+
* **À propos** 👤 : Infos sur Cyrex Studio, compétences, outils et technologies.
54+
* **Projets** 🚀 : Présentation interactive de BitsDefender, Keyscapes et StreamIt.
55+
* **FAQ interactive** ❓ : Questions/réponses avec ouverture/fermeture animée.
56+
* **Responsive** 📱💻 : Optimisé pour ordinateurs, tablettes et mobiles.
57+
* **Back-to-top button** ⬆️ : Retour rapide en haut de page.
58+
59+
# Démo
60+
61+
Une démo en ligne est disponible :
62+
👉 [https://www.cyrex.fr/](https://www.cyrex.fr/)
63+
64+
# Structure du projet
65+
66+
```
67+
CyrexStudio/
68+
├── index.html # Page principale
69+
├── style.css # Styles et thèmes Liquid Glass
70+
├── script.js # Logique interactive (FAQ, animations, back-to-top)
71+
├── assets/ # Médias (logos, images, icônes, projets)
72+
│ ├── cyrex.png
73+
│ ├── shields/ # Icônes des compétences et outils
74+
│ └── projects/ # Images des projets
75+
└── README.md # Documentation du projet
76+
```
77+
78+
# Contributeurs
79+
80+
Merci aux personnes et ressources ayant contribué au projet:
81+
82+
- [LoupesDEV](https://github.com/LoupesDEV) — Développement principal, conception et maintenance.
83+
84+
Vous souhaitez contribuer ? Consultez le [guide de contribution](CONTRIBUTING.md) ou ouvrez une *issue* pour proposer
85+
des améliorations.
86+
87+
<p align="center">
88+
<img alt="Footer" src="https://i.imgur.com/fnZRNIn.png">
89+
<br><br>
90+
<img src="https://ziadoua.github.io/m3-Markdown-Badges/badges/LicenceGPLv3/licencegplv33.svg">
91+
</p>

0 commit comments

Comments
 (0)