Skip to content

Commit 702a634

Browse files
HenraLHenraL
committed
[ADD] base of the website for creating the mokup
1 parent 2936f77 commit 702a634

File tree

228 files changed

+201384
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

228 files changed

+201384
-0
lines changed

‎.gitignore‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# No build/cache files
2+
*.o
3+
*.vs
4+
*.env
5+
*.out
6+
*.idea
7+
**/out/**
8+
*.vscode
9+
*.DS_Store
10+
*.code-workspace
11+
12+
# No temporary files
13+
*tmp*
14+
15+
database/cache/**
16+
!database/cache/.gitkeep
17+
18+
front/cache/**
19+
!front/cache/.gitkeep
20+
21+
server/cache/**
22+
!server/cache/.gitkeep
23+
24+
# No build files
25+
bin/*
26+
build/*
27+
_deps/*
28+
dist/*
29+
**/_deps/*
30+
31+
# allow sample environments
32+
!sample.env
33+
34+
# No editor config files
35+
.vscode
36+
37+
# No archives
38+
*.gz
39+
*.zip
40+
*.tar.gz

‎CODE_OF_CONDUCT.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# **Asperboard mockup Repository Code of Conduct**
2+
3+
This project and its community are dedicated to providing a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
4+
5+
We are committed to making participation in the Asperboard mockup repository a positive experience for all contributors. By participating in this project, you agree to abide by the following standards of behavior.
6+
7+
## 1. **Respectful Communication**
8+
9+
We are committed to ensuring that our communication remains constructive, inclusive, and respectful.
10+
11+
- **Be Considerate**: Treat all contributors with kindness, understanding, and empathy. Disagreements are part of any project, but always aim to address them respectfully and thoughtfully.
12+
- **No Tolerance for Harassment**: Harassment in any form, whether verbal, physical, or online (such as in pull requests, issues, or code comments), will not be tolerated. This includes personal attacks, trolling, and inappropriate comments.
13+
14+
## 2. **Inclusive and Welcoming Environment**
15+
16+
We welcome contributions from everyone, regardless of background, experience, or expertise.
17+
18+
- **Encourage and Support**: Support each other and help newer contributors with questions, problems, and feedback.
19+
- **Be Mindful of Language**: Avoid using discriminatory or exclusionary language. This includes offensive jokes, slurs, or anything that can be seen as unwelcoming.
20+
- **Constructive Feedback**: Offer feedback that is specific, constructive, and actionable. When reviewing contributions, focus on code quality and project goals, not personal qualities.
21+
22+
## 3. **Collaborative Spirit**
23+
24+
Collaboration is at the heart of open-source projects. Let's ensure all contributions, whether large or small, are appreciated.
25+
26+
- **Share Credit**: Give credit where it is due. If you are building upon someone else's work, acknowledge and cite it.
27+
- **Be Open-Minded**: Embrace new ideas and consider alternate solutions. Don't dismiss others' ideas without thoughtful consideration.
28+
- **Accept Criticism Gracefully**: Everyone has room to grow. If you receive feedback on your contributions, respond to it with an open mind and a willingness to improve.
29+
30+
## 4. **Personal Responsibility**
31+
32+
As contributors, we are all responsible for maintaining a positive community.
33+
34+
- **Act Professionally**: Whether contributing to code, documentation, or discussions, maintain professionalism and approachability.
35+
- **Report Violations**: If you see any violations of this Code of Conduct, please report them. Your reports will be taken seriously and dealt with accordingly.
36+
37+
## 5. **Avoiding Unacceptable Behavior**
38+
39+
Certain behaviors are strictly prohibited in this community:
40+
41+
- **Harassment and Discrimination**: Any form of harassment, including hate speech, exclusionary comments, and personal insults, is prohibited.
42+
- **Abusive or Offensive Language**: Any form of abusive language, including threats, slurs, and insults, will result in immediate action.
43+
- **Trolling or Spamming**: Engaging in disruptive activities like trolling, spamming, or spreading misinformation will not be tolerated.
44+
- **Unethical Contributions**: Any contribution that violates ethical guidelines, including plagiarism, copyright infringement, or harmful code, is unacceptable.
45+
46+
## 6. **Reporting and Enforcement**
47+
48+
If you experience or witness behavior that violates this Code of Conduct, we encourage you to report it to the maintainers. All reports will be treated with discretion and respect.
49+
50+
- **How to Report**: You can report violations via the GitHub issue tracker, by direct message to the maintainers, or by email (if applicable). Please include as much detail as possible, including any links to problematic discussions, contributions, or issues.
51+
- **Enforcement**: We take violations of this Code of Conduct seriously. Depending on the severity of the violation, actions may include a warning, temporary suspension, or permanent ban from the repository and related communication channels.
52+
53+
## 7. **Consequences of Violating the Code of Conduct**
54+
55+
The maintainers of the Asperboard mokup repository reserve the right to take appropriate action if any part of this Code of Conduct is violated. This may include:
56+
57+
- A formal warning to the contributor.
58+
- Temporary or permanent removal from the project or communication channels.
59+
- Immediate suspension of contribution privileges, if the violation is severe.
60+
61+
### 8. **Inspiration**
62+
63+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), which is a widely adopted open-source project standard. If you are interested in a deeper exploration of open-source community values, we recommend reading through the original document.
64+
65+
---
66+
67+
### **By contributing to this project, you agree to abide by this Code of Conduct.**
68+
69+
Thank you for helping make the Asperboard mokup repository a positive and inclusive environment for all!

‎COMMIT_CONVENTION.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Commit convention
2+
3+
This file will describe the norm used for commits in this repository.
4+
5+
This repository does not use the conventional commit down to the letter.
6+
7+
---
8+
9+
## Commit Message Convention
10+
11+
Each commit message must follow one of the two formats below:
12+
13+
- `lowecase infinitive verb: <concise description>`
14+
- `[uppercase infinitive verb] <concise description>`
15+
16+
Additional details about the commit sections:
17+
18+
- **Prefix**: The commit message should always begin with an action verb in its infinitive form. The verb should describe the type of change being made.
19+
- **Description**: After the verb, provide a brief description of what has been done in that commit. Avoid past tense or gerunds (form of a verb that ends in "-ing" and functions as a noun in a sentence).
20+
- **Body (Optional)**: There are no specific rules for the commit body. You can add details as necessary in subsequent lines.
21+
22+
### Examples
23+
24+
- `add: a new service endpoint for user management`
25+
- `fix: login endpoint handling edge cases`
26+
- `update: documentation with new examples`
27+
- `[REMOVE] redundant code from the user service`
28+
- `[EDIT] UI to match updated mockups`
29+
- `[RENAME] Readme.md -> README.md`
30+
31+
### Common Commit Verbs
32+
33+
| Verb | Description | Example |
34+
|--------------|------------------------------------------------------|-----------------------------------------|
35+
| **ADD** | Introduces new functionality, features, or files | `add: cron jobs to clean expired tokens` |
36+
| **FIX** | Corrects bugs or issues in the codebase | `fix: the database connection timeout` |
37+
| **UPDATE** | Improves or modifies existing functionality | `update: the login flow for better UX` |
38+
| **REMOVE** | Deletes or removes code, files, or dependencies | `remove: outdated npm packages` |
39+
| **EDIT** | Adjusts or alters existing code without major change | `edit: the README for better clarity` |
40+
| **REFACTOR** | Refactors code without changing its behavior | `refactor: server-side validation logic`|
41+
| **RENAME** | Renames files or variables | `rename: variables to follow naming convention` |
42+
| **MERGE** | Merges branches or pull requests | `merge: branch 'feature-auth' into dev`|
43+
44+
### Additional Notes
45+
46+
- **Prefixes** should always be in uppercase to clearly identify the action if they are encapsulated by `[]`, however, if they are followed not encapsulated by `[]` and followed by a `:` they should be in lowercase.
47+
- Try to keep descriptions concise and to the point. Use the body for further elaboration if needed.
48+
- If the commit is related to workflows or external dependencies, be explicit in the description.
49+
50+
### Examples from this Repository
51+
52+
- `add: Player constructor`
53+
- `fix: redundance on constructor arguments`
54+
- `add: AllyMissile and EnemyMissile constructors`
55+
- `add: calling OnCreate() function on constructors`
56+
- `add: Monster and DroppableMonster constructors, Monster TakeDamage`
57+
- `[FIX] the path to the import of the EntityNode.hpp file`
58+
- `[ADD] a window utility management class`
59+
- `[ADD] a window that can open`
60+
- `[FIX] exception handling issues`
61+
- `[UPDATE] the type of the mainloop function`

‎CONTRIBUTING.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Contributing to Area Rattrapage
2+
3+
Thank you for considering contributing to Area Rattrapage! This document outlines the guidelines and processes for making contributions to the project.
4+
5+
---
6+
7+
## Table of Contents
8+
9+
1. [Code of Conduct](#code-of-conduct)
10+
2. [How to Contribute](#how-to-contribute)
11+
- [Reporting Issues](#reporting-issues)
12+
- [Feature Requests](#feature-requests)
13+
- [Submitting Changes](#submitting-changes)
14+
3. [Coding Guidelines](#coding-guidelines)
15+
4. [Commit Message Convention](#commit-message-convention)
16+
5. [Pull Request Process](#pull-request-process)
17+
6. [Setting Up the Development Environment](#setting-up-the-development-environment)
18+
19+
---
20+
21+
## Code of Conduct
22+
23+
We adhere to a [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment for all contributors. Please read it before contributing.
24+
25+
---
26+
27+
## How to Contribute
28+
29+
### Reporting Issues
30+
31+
If you encounter a bug or have a question:
32+
33+
1. Check if the issue has already been reported in the [Issues section](https://github.com/Hanra-s-work/area-rattrapage/issues).
34+
2. If not, create a new issue using the **Bug Report** or **Question** template.
35+
3. Include detailed steps to reproduce the bug or context about your question.
36+
37+
### Feature Requests
38+
39+
To propose a new feature:
40+
41+
1. Check if the feature has already been requested.
42+
2. Open a new issue using the **Feature Request** template.
43+
3. Clearly describe the problem the feature solves and, if possible, provide examples of how it would be used.
44+
45+
### Submitting Changes
46+
47+
To contribute code:
48+
49+
1. Fork the repository.
50+
2. Create a new branch following the naming convention: `feature/<description>` or `fix/<description>`
51+
3. Make your changes following the [Coding Guidelines](#coding-guidelines).
52+
4. Test your changes thoroughly.
53+
54+
---
55+
56+
## Coding Guidelines
57+
58+
- Follow the repository’s style guide and adhere to best practices.
59+
- Ensure all code is **well-documented** and includes meaningful comments.
60+
- Write tests where applicable and ensure all existing tests pass.
61+
- Use the following tools (if applicable):
62+
- **Docker** for containerization.
63+
- **Github Actions** for CI/CD.
64+
65+
---
66+
67+
## Commit Message Convention
68+
69+
All commit messages **must** follow the format below:
70+
`[INFLECTED VERB] <concise description>`
71+
72+
See [COMMIT_CONVENTION.md](COMMIT_CONVENTION.md) for details and examples.
73+
74+
---
75+
76+
## Pull Request Process
77+
78+
1. Ensure your branch is up to date with the `main` branch.
79+
2. Create a pull request with a clear title and description of your changes.
80+
3. Link any relevant issues in the pull request description.
81+
4. Ensure the following checks pass:
82+
- Code adheres to the guidelines.
83+
- All tests pass.
84+
- There are no conflicts with the `main` branch.
85+
86+
5. A reviewer will assess your pull request. Please address their feedback promptly.
87+
88+
---
89+
90+
## Setting Up the Development Environment
91+
92+
In order to use the project locally, please, make sure you have docker installed and running, then run the following command for your system command:
93+
94+
You can see the [Getting started](./README.md#getting-started) in the readme server.

‎front/cache/.gitkeep‎

Whitespace-only changes.

‎front/dockerfile‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
FROM httpd:alpine3.21
2+
COPY ./html/ /usr/local/apache2/htdocs/

‎front/html/.gitkeep‎

Whitespace-only changes.

‎front/html/api/v1/oauth/callback/index.html‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!DOCTYPE html>
2+
<html data-bs-theme="light" lang="en">
3+
4+
<head>
5+
<meta charset="utf-8">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
7+
<title>Dashboard</title>
8+
<meta name="theme-color" content="#86c8ed">
9+
<link rel="canonical" href="https://dashboard.pingpal.news/api/v1/oauth/callback/">
10+
<meta property="og:url" content="https://dashboard.pingpal.news/api/v1/oauth/callback/">
11+
<meta name="twitter:title" content="Dashboard">
12+
<meta name="author" content="Henry LETELLIER,">
13+
<meta name="robots" content="index, follow, max-image-preview:standard">
14+
<meta name="copyright" content="© Henry Letellier">
15+
<meta name="publisher" content="Henry Letellier">
16+
<meta property="og:type" content="website">
17+
<meta name="twitter:card" content="summary_large_image">
18+
<meta name="twitter:description" content="This is the epitech rattrapage project to allow one to see general information about what they wish from the offered api endpoints.">
19+
<meta name="description" content="This is the epitech rattrapage project to allow one to see general information about what they wish from the offered api endpoints.">
20+
<meta property="og:image" content="https://dashboard.pingpal.news/assets/img/DashBoard logo.png">
21+
<link rel="icon" type="image/png" sizes="912x1036" href="../../../../assets/img/DashBoard%20logo.png">
22+
<link rel="icon" type="image/png" sizes="912x1036" href="../../../../assets/img/DashBoard%20logo.png" media="(prefers-color-scheme: dark)">
23+
<link rel="icon" type="image/png" sizes="912x1036" href="../../../../assets/img/DashBoard%20logo.png">
24+
<link rel="icon" type="image/png" sizes="912x1036" href="../../../../assets/img/DashBoard%20logo.png" media="(prefers-color-scheme: dark)">
25+
<link rel="icon" type="image/png" sizes="912x1036" href="../../../../assets/img/DashBoard%20logo.png">
26+
<link rel="icon" type="image/png" sizes="912x1036" href="../../../../assets/img/DashBoard%20logo.png">
27+
<link rel="icon" type="image/png" sizes="912x1036" href="../../../../assets/img/DashBoard%20logo.png">
28+
<link rel="stylesheet" href="../../../../assets/bootstrap/css/bootstrap.min.css">
29+
<link rel="manifest" href="../../../../manifest.json" crossorigin="use-credentials">
30+
<link rel="stylesheet" href="../../../../assets/css/OpenDyslexic.css">
31+
<link rel="stylesheet" href="../../../../assets/css/OpenDyslexic%203.css">
32+
<link rel="stylesheet" href="../../../../assets/css/OpenDyslexic3.css">
33+
<link rel="stylesheet" href="../../../../assets/css/OpenDyslexicAlta.css">
34+
<link rel="stylesheet" href="../../../../assets/css/OpenDyslexicMono.css">
35+
<link rel="stylesheet" href="../../../../assets/css/dropdown.css">
36+
<link rel="stylesheet" href="../../../../assets/css/Login-Form-Basic-icons.css">
37+
</head>
38+
39+
<body>
40+
<script src="../../../../assets/bootstrap/js/bootstrap.min.js"></script>
41+
<script src="../../../../assets/js/callback/redirect.js"></script>
42+
<script src="../../../../assets/js/clearer.js"></script>
43+
<script src="../../../../assets/js/dashboard/logout.js"></script>
44+
<script src="../../../../assets/js/font-selector.js"></script>
45+
<script src="../../../../assets/js/modules/constants.mjs" type="module"></script>
46+
<script src="../../../../assets/js/modules/cookies.mjs" type="module"></script>
47+
<script src="../../../../assets/js/modules/indexeddb_manager.mjs" type="module"></script>
48+
<script src="../../../../assets/js/modules/manage_server.mjs" type="module"></script>
49+
<script src="../../../../assets/js/modules/querier.mjs" type="module"></script>
50+
<script src="../../../../assets/js/modules/widget_manager.mjs" type="module"></script>
51+
<script src="../../../../assets/js/sleep.js"></script>
52+
<script src="../../../../assets/js/spacer.js"></script>
53+
</body>
54+
55+
</html>

0 commit comments

Comments
 (0)