Update README.md

This commit is contained in:
Eddy
2024-11-22 23:59:19 +01:00
committed by GitHub
parent 395bbd8a5f
commit 5247a2013b

106
README.md
View File

@ -1,68 +1,68 @@
# **ft_transcendence** - METH PROJECT # **ft_transcendence** - METH PROJECT
**Un projet web complet combinant les technologies modernes et des fonctionnalités innovantes.** <div align="center">
<h4>A complete web project combining modern technologies and innovative features.</h2>
<img src="https://github.com/user-attachments/assets/25c2523f-751c-4b55-971f-e238258f4c1a" alt="meth_home">
<p style="font-size=2px">Home page</p>
<p>Welcome to METH's GitHub page! Come and try our game on PC, smartphone, and even VR, blending the old with the modern.</p>
</div>
## **Table des matières**
## **Table of Contents**
1. [Introduction](#introduction) 1. [Introduction](#introduction)
2. [Technologies utilisées](#technologies-utilisées) 2. [Technologies Used](#technologies-used)
3. [Accès](#accès) 3. [Access](#access)
4. [Installation](#installation) 4. [Installation](#installation)
5. [Module majeur & mineur](#module-majeur-&-mineur) 5. [Major & Minor Modules](#major-and-minor-modules)
6. [Autheurs](#autheurs) 6. [Authors](#authors)
--- ---
## **Introduction** ## **Introduction**
**ft_transcendence** est un projet réalisé dans le cadre du cursus de l'École 42. Il s'agit d'une application web complète, combinant un front-end moderne avec une architecture back-end robuste, permettant aux utilisateurs de jouer a Pong, pour le plaisir, en local, en ligne, en ranked. **ft_transcendence** is a project developed as part of the 42 school curriculum. It is a complete web application, combining a modern front-end with a robust back-end architecture, enabling users to play Pong for fun, locally, online, or in ranked mode.
--- ---
## **Technologies utilisées** ## **Technologies Used**
- **Front-end** : HTML, CSS, JS (Vanilla), ThreeJS - **Front-end**: HTML, CSS, JS (Vanilla), ThreeJS
- **Back-end** : Python (Django), WebSockets - **Back-end**: Python (Django), WebSockets
- **Jeu** : JS, ThreeJS - **Game**: JS, ThreeJS
- **Base de données** : PostgreSQL - **Database**: PostgreSQL
- **Authentification** : Création de compte par mail et confirmation et authentification par 42. - **Authentication**: Account creation via email confirmation and 42 authentication.
- **Autres** : Docker pour la containerisation. - **Others**: Docker for containerization.
--- ---
## **Accès** ## **Access**
Nous avons la chance qu'un des membres de notre équipe puisse héberger le site sur son serveur. We are fortunate to have a team member hosting the website on their server.
Vous pouvez donc accéder à notre site avec toutes les fonctionnalités depuis : You can access the site with all its features at:
``` ```
meth.tmoron.fr meth.tmoron.fr
``` ```
Si vous avez le moindre bug sur le site, veillez contacter un membre de l'équipe pour la corriger. If you encounter any bugs on the site, please contact a team member to resolve them.
--- ---
## **Installation** ## **Installation**
### **Prérequis** ### **Prerequisites**
- Docker & Docker Compose - Docker & Docker Compose
- PostgreSQL
### **Étapes d'installation** ### **Installation Steps**
1. Clonez le dépôt : 1. Clone the repository:
```bash ```bash
git clone https://github.com/METH_Transcendence/ft_transcendence.git git clone https://github.com/Kum1ta/METH_Transcendence.git
cd ft_transcendence cd METH_Transcendence
``` ```
2. Installez les dépendances : 2. Configure environment variables :
```bash - Create a `.env` file in the root directory and fill in the required values :
npm install
``` ```bash
3. Configurez les variables d'environnement :
- Créez un fichier `.env` à la racine et renseignez les valeurs nécessaires :
```
DB_NAME="" DB_NAME=""
DB_USERNAME="" DB_USERNAME=""
DB_PASSWORD="" DB_PASSWORD=""
@ -76,32 +76,32 @@ Si vous avez le moindre bug sur le site, veillez contacter un membre de l'équip
SERVER_URL="https://localhost:8000" SERVER_URL="https://localhost:8000"
``` ```
4. Lancez le projet : 3. Launch the project :
```bash ```bash
make make
``` ```
5. Accédez à l'application sur [http://localhost:3000](http://localhost:3000). 4. Access the application at [https://localhost:8000/](https://localhost:8000/)
--- ---
## **Module majeur & mineur** ## **Major and Minor Modules**
- **Utiliser un framework backend** - **Use a backend framework**
- **Utiliser une base de données backend** - **Use a backend database**
- **Gestion utilisateur standard, authentification, utilisateurs en tournois** - **Standard user management, authentication, and tournament users**
- **Implementer une authentification à distance** - **Implement remote authentication**
- **Joueur à distance** - **Remote multiplayer support**
- **Ajout d'un second jeu avec historique et matchmaking** - **Add a second game with history and matchmaking**
- **Option de personnalisation du jeu** - **Game customization options**
- **Live chat** - **Live chat**
- **Implementer un adversaire contole par IA** - **Implement an AI-controlled opponent**
- **Panneaux d'affichage (Dashboard), statistiques des parties** - **Dashboards and game statistics**
- **RGPD friendly** - **GDPR compliance**
- **Utilisation de technique avancées 3D** - **Advanced 3D techniques**
- **Supoort sur tous types d'appareils (PC/Telephone, VR, Manette)** - **Support for all devices (PC/Phone, VR, Gamepad)**
- **Responsive** - **Responsive design**
## **Autheurs** ## **Authors**
- Mathis, madegryc [https://github.com/Misthaa] - Front-end/Design - Mathis, madegryc [https://github.com/Misthaa] - Front-end/Design
- Eddy, edbernar [https://github.com/Kum1ta] - Full Stack - Eddy, edbernar [https://github.com/Kum1ta] - Full Stack