Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tdameros committed Mar 20, 2024
1 parent a4ce8dd commit 5aefb28
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 44 deletions.
File renamed without changes.
63 changes: 19 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,11 @@



Transcendence is a project at 42 School aimed at introducing us to the web by creating a competitive multiplayer Pong.

Transcendence is a project at 42 School aimed at familiarizing us with web development by creating a competitive multiplayer version of Pong.


https://github.com/tdameros/42-transcendence/assets/97832618/af364140-2886-4818-b81b-99d09d70ce3e



<table align=center>
<thead>
<tr>
<th colspan=2>Some renders</th>
</tr>
</thead>
<tbody>
<tr>
<td><image src="assets/homepage.png"></image></td>
<td><image src="assets/pong.png"></image></td>
</tr>
</tbody>
</table>




## Usage

Generate the `.env` file using .env.example as a template.
Expand All @@ -49,28 +29,29 @@ make

## Features

- Remote player
- Remote authentication
- Microservices architecture
- 3D pong game
- GDPR compliant
- User and game statistics
- Remote player functionality
- Remote authentication capability
- Microservices architecture implementation
- 3D pong game integration
- GDPR compliance
- User and game statistics tracking
- Support for multiple devices
- Tournament with a maximum of 32 players
- Ranking system
- Elo based matchmaking
- Tournament feature accommodating up to 32 players
- Ranking system implementation
- Elo-based matchmaking system

## Technologies

## Techonologies
![](assets/technologies.png)

- Docker (images only based on debian bookworm)
- Docker compose
- Python 3.12
- Django 4.2.7
- Bootstrap 5.3
- Vitejs (with only vanilla js)
- Postgres 14 and Redis 7.2.4

## Microservices Architecture

![](assets/architecture.png)

## Databases Architecture

![](assets/databases.png)

## Default Ports

Expand All @@ -83,12 +64,6 @@ make
- Game creator: 6006
- Game server: 50200:50400

## Microservices Architecture

We have chosen to use a microservices architecture.

![](assets/architecture.png)

## Documentation

- [General](doc/documentation.md)
Expand Down
Binary file added assets/databases.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/technologies.png
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 5aefb28

Please sign in to comment.